Get storefront

Deprecated. This page documents the v2 buyer API, which is closed to new API clients and switches off on 1 December 2026. Use V3 instead: see Move a v2 buyer REST integration to V3. The conversion endpoint, Log event, stays open.

GET /api/v2/buyer/storefronts/{storefrontId} Returns a single storefront with canonical transaction readiness and separate rolled-up connection state: connected, requiresCredentials, and your registered customerAccounts. Use readiness.canTransact for availability. Use connection fields to diagnose buyer credential setup, for example after registering credentials or completing OAuth. Use the capabilities endpoint when you need source-level diagnostic rows.

Request

curl

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

Parameters

Field	In	Type	Required	Notes
`storefrontId`	path	integer	Yes	Storefront ID to fetch

Response

{
  "id": 42,
  "platformId": "premium-ctv",
  "name": "Premium CTV Storefront",
  "publisherDomain": "premium-ctv.example.com",
  "displayStatus": "neutral",
  "readiness": {
    "canTransact": true,
    "effectiveStatus": "live",
    "blockerIds": []
  },
  "channels": ["CTV", "display"],
  "adapterProviderType": null,
  "supportedRoutingTypes": ["DECISIONED", "ROUTED"],
  "regions": ["GB", "US"],
  "connected": false,
  "requiresCredentials": true,
  "customerAccounts": [
    {
      "accountIdentifier": "buyer-seat-123",
      "status": "ACTIVE"
    }
  ],
  "adcpCapabilities": null
}

Field	Type	Notes
`id`	integer	Storefront ID
`platformId`	string	Public-facing slug
`name`	string	Storefront display name
`publisherDomain`	string \| null	Publisher domain
`displayStatus`	enum	Deprecated stored-control compatibility label; not purchasing availability
`readiness.canTransact`	boolean	Canonical answer to whether ordinary buyer traffic may transact now
`readiness.effectiveStatus`	enum	`archived`, `paused`, `blocked`, or `live`
`readiness.blockerIds`	string[]	Machine-readable blocker IDs; empty when live
`channels`	array	Supported channels
`regions`	array	The countries the storefront sells in, as ISO country codes. `WORLDWIDE` means it accepts every country. Empty means the seller names no country, so it is in every country. The name is kept for compatibility; old merchandising regions are retired.
`adapterProviderType`	string \| null	Adapter platform, `null` for non-adapter
`supportedRoutingTypes`	array	Deprecated v2 compatibility placeholder. Always both legacy values; do not use for storefront type or behavior.
`connected`	boolean	Whether the buyer has the required credentials/account setup. This does not mean the seller is transaction-ready.
`requiresCredentials`	boolean	Whether any source behind the storefront requires buyer credentials
`customerAccounts`	array	Registered buyer accounts, deduped across the storefront
`adcpCapabilities`	object \| null	Rolled-up capability manifest when cached capability data exists

customerAccounts is scoped to the authenticated buyer. On Storefront MCP discovery calls, supplying an opaque account ID without that buyer/storefront grant fails closed with ACCOUNT_NOT_FOUND and details.reason: "account_not_authorized_for_buyer". Use an account returned for the current buyer; an account visible to another buyer is not reusable.

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

Get storefront capabilities

Source-level capability diagnostics

Start building

Core Concepts

Buyer operations

Seller operations

Cross-Cutting Reference

Buyer API reference

Seller API reference

Release Notes

Request

Parameters

Response

Errors

Storefront tasks

Register source credentials

List storefronts

Get storefront capabilities

​Request

​Parameters

​Response

​Errors

​Related

Storefront tasks

Register source credentials

List storefronts

Get storefront capabilities

Request

Parameters

Response

Errors

Related