Skip to main content
GET
/
storefronts
/
{storefrontId}
Get storefront
curl --request GET \
  --url https://api.interchange.io/api/v2/buyer/storefronts/{storefrontId} \
  --header 'Authorization: Bearer <token>'
{
  "id": 0,
  "platformId": "<string>",
  "name": "<string>",
  "publisherDomain": "<string>",
  "channels": [
    "CTV",
    "display"
  ],
  "adapterProviderType": "<string>",
  "creativeCapabilities": {
    "kind": "creative_generation",
    "modalities": [],
    "transformerIds": [
      "<string>"
    ],
    "supportedFormatIds": [
      "<string>"
    ],
    "supportedFormatCount": 4503599627370495,
    "supportsBuildCreative": true,
    "supportsPreviewCreative": true
  },
  "adapterConnection": {
    "authModes": [],
    "accountCount": 4503599627370495,
    "selectedAccountName": "<string>"
  },
  "supportedCampaignTypes": [],
  "regions": [
    "UK",
    "EMEA"
  ],
  "connected": true,
  "requiresCredentials": true,
  "customerAccounts": [
    {
      "accountIdentifier": "<string>",
      "status": "<string>"
    }
  ],
  "adcpCapabilities": {
    "supportsUpdateMediaBuy": true,
    "supportsCreateMediaBuy": true,
    "supportsGetReporting": true,
    "supportsSandbox": true,
    "extensions": [
      "<string>"
    ],
    "protocols": [
      "<string>"
    ],
    "version": "<string>",
    "reportingDeliveryMethods": [],
    "offlineDeliveryProtocols": [],
    "capabilitiesCachedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key or access token

Path Parameters

​
storefrontId
integer
required

Storefront ID

Required range: x <= 9007199254740991

Response

Get storefront

A storefront as seen by a buyer

​
id
integer
required

Storefront ID

Required range: -9007199254740991 <= x <= 9007199254740991
​
platformId
string
required

Public-facing slug

​
name
string
required

Storefront display name

​
publisherDomain
string | null
required

Publisher domain

​
displayStatus
enum<string>
required

Read-only display status derived from transacting and archivedAt. configuring: setup in progress, not accepting transactions. transacting: live and accepting transactions. archived: archived (read-only).

Available options:
configuring,
transacting,
archived
​
channels
string[]
required

Ad channels this storefront supports (e.g. "display", "CTV", "audio"). Empty array if not specified.

Example:
["CTV", "display"]
​
adapterProviderType
string | null
required

Adapter platform type (e.g. "meta", "tiktok"). Null for non-adapter storefronts.

​
adapterSourceKind
enum<string> | null
required

Adapter family for official adapter storefronts, such as sales or creative. Null for non-adapter storefronts.

Available options:
sales,
creative,
signals,
measurement,
optimization,
composite
​
creativeCapabilities
object
required

Creative-generation capabilities when this is a creative adapter storefront; null otherwise.

​
adapterConnection
object
required

Buyer-specific connection state for official adapter storefronts; null for non-adapter storefronts or when connection state was not requested.

​
supportedCampaignTypes
enum<string>[]
required

Campaign types supported by this storefront. Adapter storefronts are ROUTED-only.

Available options:
DECISIONED,
ROUTED
​
regions
string[]
required

Operator-curated regions this storefront covers (ISO 3166-1 alpha-2 country codes or group codes like WORLDWIDE, EMEA, NORAM). Empty array if not specified.

Example:
["UK", "EMEA"]
​
connected
boolean
required

Whether the storefront is ready to transact: every inventory source the buyer needs is connected.

​
requiresCredentials
boolean
required

Whether the buyer must register credentials before they can transact with this storefront.

​
customerAccounts
object[]
required

The buyer's registered accounts for this storefront, aggregated across its inventory sources and deduped by accountIdentifier.

​
adcpCapabilities
object
required

AdCP capability manifest for the storefront's underlying agent(s). Non-null for agent-based storefronts with cached capability data; null for adapter storefronts or when no capability data has been fetched yet.