How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Scope3 Storefronts API

The Storefronts API from Scope3 — 18 operation(s) for storefronts.

Scope3 Storefronts API is one of 51 APIs that Scope3 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Storefronts. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 19 operations across 18 paths, and defines 43 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://api.interchange.io/api/v2/buyer.

19 operations 18 paths 43 schemas 2 DELETE10 GET2 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://aiapi.scope3.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Scope3 Storefronts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — API key or access token

Paths & Operations 19

Across 18 paths, the API surfaces 19 operations — 2 DELETE, 10 GET, 2 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Storefronts 19
GET
/storefronts
List storefronts
listStorefronts 8 params → 200400401500
GET
/storefronts/{storefrontId}
Get storefront
getStorefront 1 param → 200400401500
GET
/storefronts/{storefrontId}/capabilities
Get storefront capabilities
getStorefrontCapabilities 1 param → 200400401500
GET
/storefront-connections
List storefront connections
listStorefrontConnections 1 param → 200400401500
GET
/storefront-connection-account-mappings
List external account mappings
listStorefrontConnectionAccountMappings 7 params → 200400401500
GET
/storefront-connections/{connectionId}/accounts
List integration external accounts
listStorefrontConnectionAccounts 1 param → 200400401500
DELETE
/storefront-connections/{connectionId}
Remove storefront connection
removeStorefrontConnection 1 param → 200400401500
PATCH
/storefront-connections/{connectionId}/accounts/{accountId}/select
Select integration external account
selectStorefrontConnectionAccount 2 params → 200400401500
POST
/storefront-connections/{connectionId}/accounts/{accountId}/advertiser
Map external account to advertiser
mapStorefrontConnectionAccountToAdvertiser 2 params body → 201400401500
POST
/storefront-connections/{connectionId}/accounts/{accountId}/directed-campaigns/subscribe
Subscribe a directed-campaign account (alpha)
subscribeDirectedCampaigns 2 params body → 201400401403404500
GET
/storefront-connections/{connectionId}/accounts/{accountId}/directed-campaigns/subscription
Get directed-campaign subscription health (alpha)
getDirectedCampaignSubscription 2 params → 200400401500
DELETE
/storefront-connections/{connectionId}/accounts/{accountId}/directed-campaigns/subscription
Unsubscribe a directed-campaign account (alpha)
unsubscribeDirectedCampaigns 2 params → 200400401500
GET
/storefront-connections/{connectionId}/accounts/{accountId}/presences
List account presences (alpha)
listStorefrontConnectionAccountPresences 6 params → 200400401403404500
PATCH
/storefronts/{storefrontId}/connection-policy
Update storefront connection policy
updateStorefrontConnectionPolicy 1 param body → 200400401500
POST
/storefronts/{storefrontId}/connection
Connect storefront
connectStorefront 1 param → 200400401500
GET
/storefronts/credentials
List credentials
listStorefrontCredentials → 200400401500
POST
/storefronts/{storefrontId}/sources/{sourceId}/credentials
Register source credentials
registerSourceCredentials 2 params body → 201400401500
POST
/storefronts/{storefrontId}/sources/{sourceId}/adcp-connection
Connect a registered AdCP source (alpha)
connectAdcpStorefront 2 params body → 201400401403409422500
GET
/storefronts/{storefrontId}/publishers
List publisher domains for a storefront
listBuyerStorefrontPublishers 5 params → 200400401500

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are BuyerStorefront (27 properties), BuyerStorefrontSummary (24 properties), DirectedCampaignSubscription (22 properties), StorefrontConnectionAccount (20 properties). Each schema is shown below with its type and property counts.

DirectedCampaignSyncOutcome
object
Counts and bounded safe diagnostics from one account-wide mirror reconciliation.
10 properties 5 required
StorefrontPresence
object
Read-only wire projection of a storefront-connection-account presence edge -- identity, status, and counts only, never member lists or event payloads.
12 properties 10 required
BuyerStorefrontCapabilitySource
object
Source-level storefront capability diagnostic row
9 properties 9 required
ConnectedAdcpStorefront
object
Connection/account identifiers for a registered AdCP storefront source ready for an explicit tracked-campaign subscription.
9 properties 9 required
StorefrontConnectionAccountCampaignRollup
object
Directed-campaign rollup for one connected account: tracked = mirrored read-only from the connected seller account; managed = authored through the platform. Sp…
7 properties 7 required
BuyerAdapterConnectionStatus
object
Buyer-specific delegated-auth status for an official adapter storefront.
5 properties 5 required
SubscribeDirectedCampaignsResponse
object
The durable subscription plus the initial one-year mirror reconciliation.
2 properties 2 required
BuyerStorefrontDiscoveryPerformance
object
Observed buyer product-discovery response timing for this storefront.
7 properties 7 required
BuyerStorefrontCapabilitiesResponse
object
Source-level capability diagnostics for a buyer storefront
2 properties 2 required
BuyerStorefrontSummary
object
Compact storefront view returned by list endpoints. Use the storefront detail endpoint for the full resource.
24 properties 24 required
StorefrontConnectionAccountsResponse
object
External accounts discovered for an integration, including advertiser mappings.
1 property 1 required
StorefrontConnectionAccountMappingsResponse
object
Paginated external account mapping table for buyer integrations.
4 properties 4 required
DiscoveryCard
object
Canonical buyer-visible storefront identity, coverage declaration, and optional Advertising Policies disclosure. Unknown coverage never means worldwide or all…
16 properties 16 required
SubscribeDirectedCampaignsBody
object
Subscribe a mapped seller account for read-only tracked-campaign mirroring.
2 properties 1 required
StorefrontConnectionHandoff
object
5 properties 5 required
ErrorResponse
object
Standard error response
2 properties 2 required
StorefrontConnectionAccountAdvertiserMapping
object
Advertiser mapping for an external account discovered through an integration.
9 properties 9 required
StorefrontPresenceListResponse
object
Paginated list of tracked/pushed presences for a storefront connection account. Offset pagination rides the standard response meta, not the body.
2 properties 2 required
BuyerDiscoveryCardSummary
object
Compact Discovery Card for Marketplace lists. Full Advertising Policies are detail-only.
17 properties 17 required
BuyerCredentialOAuthInfo
object
OAuth authorization info presented in buyer-facing storefront/source terms
4 properties 4 required
BuyerStorefrontList
object
Paginated list of storefront summaries available to a buyer
4 properties 4 required
AccountOutput
object
Linked account resource on a partner platform
14 properties 7 required
BuyerStorefrontReadiness
object
Canonical transaction eligibility for this storefront. This is independent of buyer credential connection state.
3 properties 3 required
BuyerCredentialSourceRef
object
A storefront/source pair that a single credential row gives the buyer access to
4 properties 4 required
BuyerCredential
object
A buyer's registered credential, scoped to the storefront sources it gives access to
8 properties 8 required
BuyerStorefront
object
A storefront as seen by a buyer
27 properties 26 required
BuyerStorefrontAccount
object
A buyer's registered account for a storefront
2 properties 2 required
StorefrontConnectionArchived
object
1 property 1 required
DirectedCampaignSubscription
object
Durable provider-account subscription and its read-only mirror health.
22 properties 22 required
BuyerStorefrontCapabilityDetails
object
Capability summary for an external AdCP storefront source
14 properties 11 required
StorefrontConnectionAccountMappingItem
object
External provider account row for integration-to-advertiser mapping management.
18 properties 18 required
StorefrontConnectionFeaturePolicy
object
Buyer-controlled feature policy for a storefront connection row.
4 properties 4 required
BuyerStorefrontBrandColors
objectnull
Validated brand.json colors object for rendering buyer discovery cards. Null when unresolved.
StorefrontConnectionAccount
object
Provider account discovered for a buyer storefront connection.
20 properties 19 required
ConnectAdcpStorefrontBody
object
Project a registered and advertiser-mapped AdCP storefront source into the connected-account campaign connection plane.
3 properties 2 required
StorefrontConnectionsResponse
object
Storefront connection rows and feature policies visible to a buyer.
1 property 1 required
BuyerCredentialRegistrationResponse
object
Response for registering credentials against a storefront inventory source
6 properties 5 required
UnsubscribeDirectedCampaignsResponse
object
The archived directed-campaign subscription and number of retired mirrors.
2 properties 2 required
StorefrontConnectionSummary
object
Buyer-side storefront connection row. Adapter storefronts include auth status; all storefronts include feature policy.
12 properties 9 required
BuyerStorefrontAdcpCapabilities
object
AdCP capability manifest for a storefront's underlying agent(s), derived from the cached getadcpcapabilities response. Check capabilitiesCachedAt for data fres…
15 properties 12 required
StorefrontConnectionAgentSource
object
Agent-backed inventory source eligible for external account mappings.
2 properties 2 required
ApiError
object
Structured error object
4 properties 2 required
BuyerCreativeStorefrontCapability
object
Machine-readable creative generation capability summary for an adapter storefront.
8 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

scope3-storefronts-api-openapi.yml Raw ↑

Other APIs Scope3 publishes across the network.

Scope3 AI Impact Measurement API
Scope3 Benchmarks API
Scope3 Creative API
Scope3 Data API
Scope3 Gpu API
Scope3 Impact API
Scope3 Measure API
Scope3 Model API
Scope3 Node API
Scope3 Reload API
Scope3 Saved Lists API
Scope3 Segment API
Where this information came from

This is an independent, third-party profile of Scope3 Storefronts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.