Skip to main content
GET /api/v2/buyer/storefronts/{storefrontId} Returns a single storefront with the embedded sources[] array, including each source’s requiresCredentials, connected, and your registered customerAccounts. Use it to check fresh source state — for example, after registering credentials or completing an OAuth flow.

​
Request

curl
curl https://api.interchange.io/api/v2/buyer/storefronts/42 \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

​
Parameters

FieldInTypeRequiredNotes
storefrontIdpathintegerYesStorefront ID to fetch

​
Response

{
  "id": 42,
  "platformId": "premium-ctv",
  "name": "Premium CTV Storefront",
  "publisherDomain": "premium-ctv.example.com",
  "displayStatus": "transacting",
  "channels": ["CTV", "display"],
  "adapterProviderType": null,
  "supportedCampaignTypes": ["DECISIONED", "ROUTED"],
  "regions": ["US", "EMEA"],
  "sources": [
    {
      "sourceId": "src_main",
      "name": "Premium CTV — Direct",
      "requiresCredentials": true,
      "connected": false,
      "supportedCampaignTypes": ["DECISIONED"],
      "customerAccounts": []
    }
  ]
}
FieldTypeNotes
idintegerStorefront ID
platformIdstringPublic-facing slug
namestringStorefront display name
publisherDomainstring | nullPublisher domain
displayStatusenumconfiguring, transacting, archived
channels / regionsarraySupported channels and covered regions
adapterProviderTypestring | nullAdapter platform, null for non-adapter
supportedCampaignTypesarrayDECISIONED and/or ROUTED
sourcesarrayInventory sources in this storefront
sources[].sourceIdstringSource identifier within the storefront
sources[].namestringInventory source display name
sources[].requiresCredentialsbooleanWhether the buyer must register credentials
sources[].connectedbooleanWhether the buyer has active credentials
sources[].supportedCampaignTypesarrayCampaign types this source supports
sources[].customerAccountsarray[{ accountIdentifier, status }] — the buyer’s registered accounts

​
Errors

  • 401 UNAUTHORIZED — missing or invalid bearer token.
  • 404 NOT_FOUND — the storefront does not exist or is not visible to the caller.
See Errors for the full error contract.

Storefront tasks

All storefront operations

Register source credentials

Connect a source that requires credentials

List storefronts

Paginated summaries