Scope3

Scope3 Storefront API

Manage storefront and inventory sources

GitHub OpenAPI
Business capability
Advertising Sales & Operations Management BC-3760

Operations 159

GET /account-mappings/summary Get seller account mapping summary #
GET /account-mappings List seller account relationships #
GET /account-mappings/export Export seller account mappings #
GET /account-mappings/reviews List pending buyer account requests #
POST /account-mappings/reviews/{grantId}/decision Decide a pending buyer account request #
POST /account-mappings/sources/{inventorySourceId}/refresh Refresh managed ad-server account choices #
POST /account-mappings/imports/prepare Prepare a private seller account mapping feed upload #
POST /account-mappings/imports/{revisionId}/preview Validate and preview a seller account mapping feed #
POST /account-mappings/imports/{revisionId}/commit Atomically commit a seller account mapping feed #
GET /account-mappings/imports/{revisionId} Get seller account mapping feed revision status #
GET /storefront Get storefront #
POST /storefront Create storefront #
PUT /storefront Update storefront #
PATCH /storefront Patch storefront capabilities #
GET /demo Get Demo Storefront #
POST /demo Create Demo Storefront #
DELETE /demo Delete Demo Storefront #
POST /demo/reset Reset Demo Storefront #
GET /demo/source-recipes List Demo source recipes #
POST /demo/sources Attach Demo sources #
DELETE /demo/sources/{sourceId} Remove a Demo source #
POST /demo/extend Extend Demo Storefront #
GET /readiness Get storefront readiness #
GET /readiness/compliance Get storefront compliance status #
POST /readiness/compliance/refresh Re-run the storefront compliance check #
POST /resolve-brand Resolve brand profile #
GET /discover-agents Discover agents for a domain #
GET /inventory-sources List inventory sources #
POST /inventory-sources Create inventory source #
GET /inventory-sources/{sourceId} Get inventory source #
PUT /inventory-sources/{sourceId} Update inventory source #
DELETE /inventory-sources/{sourceId} Delete inventory source #
GET /inventory-sources/{sourceId}/diagnostics Get inventory source diagnostics #
GET /inventory-sources/{sourceId}/mapping-workspace Get an inventory source mapping workspace #
POST /inventory-sources/{sourceId}/tests/discovery Run an inventory source discovery test #
GET /inventory-sources/{sourceId}/wholesale-pricing/template Download wholesale pricing template #
GET /inventory-sources/{sourceId}/property-mappings List inventory property mappings #
PUT /inventory-sources/{sourceId}/property-mappings Replace inventory property mappings #
POST /inventory-sources/ad-servers/citrusad Connect CitrusAd #
POST /inventory-sources/{sourceId}/ad-servers/citrusad/credentials/{credentialKind} Save CitrusAd credentials #
PUT /inventory-sources/{sourceId}/ad-servers/citrusad/credentials/{credentialKind} Rotate CitrusAd credentials #
DELETE /inventory-sources/{sourceId}/ad-servers/citrusad/credentials/{credentialKind} Revoke CitrusAd credentials #
POST /inventory-sources/modular/feed Create a modular source with an avails-feed module #
POST /inventory-sources/modular/cadent-demo Create Cadent demo modular source #
POST /inventory-sources/modular/freewheel-sandbox Create FreeWheel sandbox modular source #
GET /inventory-sources/{sourceId}/modular Get modular inventory source readiness #
POST /inventory-sources/{sourceId}/modular/avails-feed Ingest modular avails feed #
POST /inventory-sources/{sourceId}/modular/avails-feed/upload Preview a modular avails file #
GET /inventory-sources/{sourceId}/modular/products List modular inventory products #
GET /inventory-sources/{sourceId}/modular/work-items List modular source work items #
GET /inventory-sources/{sourceId}/modular/work-items/{workItemId} Get modular source work item #
PATCH /inventory-sources/{sourceId}/modular/work-items/{workItemId} Update modular source work item #
POST /inventory-sources/{sourceId}/modular/work-items/{workItemId}/complete Complete modular source work item #
GET /inventory-sources/{sourceId}/modular/inventory/capabilities Get modular inventory capabilities #
GET /inventory-sources/{sourceId}/modular/inventory/selectors Search modular inventory selectors #
POST /inventory-sources/{sourceId}/modular/reservations Reserve modular inventory product #
POST /inventory-sources/{sourceId}/modular/bookings/finalize Prepare modular booking handoff #
POST /inventory-sources/{sourceId}/modular/bookings/release Release modular inventory booking #
PATCH /inventory-sources/{sourceId}/modular/modules/{moduleInstanceId}/config Update modular source module config #
POST /inventory-sources/{sourceId}/modular/modules/{moduleInstanceId}/credentials/{credentialKind} Create modular source module credential #
PUT /inventory-sources/{sourceId}/modular/modules/{moduleInstanceId}/credentials/{credentialKind} Rotate modular source module credential #
DELETE /inventory-sources/{sourceId}/modular/modules/{moduleInstanceId}/credentials/{credentialKind} Revoke modular source module credential #
POST /inventory-sources/{sourceId}/feed/preview Preview a feed revision (HITL) #
POST /inventory-sources/{sourceId}/feed/upload Upload a feed file (HITL, multipart) #
POST /inventory-sources/{sourceId}/feed/commit Commit a previewed feed revision (HITL) #
POST /inventory-sources/{sourceId}/feed/push Push a feed revision (API_PUSH, no preview step) #
GET /inventory-sources/{sourceId}/esa Get ad-server source connection #
GET /inventory-sources/{sourceId}/status Get ad-server source status #
GET /inventory-sources/{sourceId}/sync-history List ad-server source sync history #
POST /inventory-sources/{sourceId}/launch Mint a launch URL into the managed source admin UI #
PUT /inventory-sources/{sourceId}/ad-server Replace ad-server source config #
PATCH /inventory-sources/{sourceId}/ad-server Replace ad-server source config (alias) #
PUT /inventory-sources/{sourceId}/adapter-config Rotate ad-server source credentials #
POST /inventory-sources/{sourceId}/test-connection Test the ad-server source connection #
POST /inventory-sources/{sourceId}/refresh Refresh the ad-server source snapshot #
POST /inventory-sources/{sourceId}/deactivate Deactivate the ad-server source #
POST /inventory-sources/{sourceId}/reactivate Reactivate a deactivated ad-server source #
POST /esa/service-account Ensure ad server source service account #
GET /esa List ad server sources #
GET /esa/{esaId} Get an ad server source #
POST /esa/{esaId}/test-connection Test an ad server source #
POST /esa/{esaId}/refresh Refresh an ad server source #
POST /esa/{esaId}/capabilities/{capability}/recheck Re-check an ad server capability #
POST /esa/{esaId}/deactivate Deactivate an ad server source #
POST /esa/{esaId}/reactivate Reactivate an ad server source #
GET /esa/{esaId}/status Get ad server source status #
GET /esa/{esaId}/sync-history List ad server source sync history #
POST /esa/{esaId}/launch Mint an ad server source launch URL #
GET /operating-instructions List operating-instructions versions #
POST /operating-instructions Create a new operating-instructions version #
GET /operating-instructions/active Get the active operating-instructions version #
GET /operating-instructions/{version} Get a specific operating-instructions version #
POST /operating-instructions/{version}/activate Activate an operating-instructions version #
GET /acceptance-policy List acceptance-policy versions #
POST /acceptance-policy Create a new acceptance-policy version #
GET /acceptance-policy/active Get the active acceptance-policy version #
GET /acceptance-policy/{version} Get a specific acceptance-policy version #
POST /acceptance-policy/{version}/activate Activate an acceptance-policy version #
PUT /learned-default-posture Pin or clear the learned default posture #
GET /buyer-instructions List buyer-instructions rows #
POST /buyer-instructions Create a buyer-instructions row #
PATCH /buyer-instructions/{id} Update a buyer-instructions row #
DELETE /buyer-instructions/{id} Delete a buyer-instructions row #
GET /house-discounts List rate-card discount rows #
POST /house-discounts Create a rate-card discount row #
GET /house-discounts/resolve Resolve a domain up its corporate hierarchy (authoring preview) #
PATCH /house-discounts/{id} Update a rate-card discount row #
DELETE /house-discounts/{id} Delete a rate-card discount row #
GET /buyer-auto-approvals List per-buyer media-buy auto-approve overrides #
PUT /buyer-auto-approvals/{buyerCustomerId} Enable or disable per-buyer media-buy auto-approve #
GET /simulator/scenarios List merchandising simulation scenarios #
POST /simulator/scenarios Create a merchandising simulation scenario #
GET /simulator/scenarios/{scenarioId} Get a merchandising simulation scenario #
POST /simulator/scenarios/{scenarioId}/revisions Append a merchandising simulation revision #
POST /simulator/scenarios/{scenarioId}/revisions/{revisionId}/variants Append a merchandising simulation variant #
POST /simulator/scenarios/{scenarioId}/revisions/{revisionId}/variants/{variantId}/executions Execute a pinned merchandising simulation variant #
GET /intelligence-runs List storefront intelligence-run records #
GET /intelligence-runs/{id} Get a storefront intelligence-run record #
GET /intelligence-runs/{id}/decision-record Get the canonical seller decision record for an intelligence run #
PUT /intelligence-runs/{id}/label Attach an evaluator label to an intelligence-run #
GET /demand-inbox Get the demand-inbox ledger #
PUT /demand-inbox/{runId}/ledger Record demand-inbox ledger annotations #
GET /demand-inbox/{runId}/exchange Get a demand exchange (proposal pass) #
POST /demand-inbox/{runId}/exchange/revisions Compose a demand exchange revision #
POST /demand-inbox/{runId}/exchange/revisions/{revisionId}/submit Submit a demand exchange revision for approval #
PUT /demand-inbox/{runId}/exchange/revisions/{revisionId}/decision Approve or reject a demand exchange revision #
POST /demand-inbox/{runId}/exchange/revisions/{revisionId}/amend Amend a demand exchange revision #
DELETE /demand-inbox/{runId}/exchange/revisions/{revisionId} Discard a demand exchange revision #
GET /brief-artifacts List canonical brief artifacts #
GET /brief-artifacts/{id} Get a canonical brief artifact #
GET /proposal-artifacts List canonical proposal artifacts #
GET /proposal-artifacts/{id} Get a canonical proposal artifact #
GET /seller-analytics Get the seller-analytics posture-conversion rollup #
GET /approval-routing Get storefront approval routing #
PUT /approval-routing/{kind} Replace one storefront approval routing policy #
PUT /approval-routing/work-items/{workItemId}/assignee Reassign an approval work item #
GET /media-buy-approvals List media-buy approval entries #
GET /media-buy-approvals/{mediaBuyId} Get a single media-buy approval entry #
POST /media-buy-approvals/{mediaBuyId}/decide Approve or reject a pending media buy #
POST /media-buy-approvals/{mediaBuyId}/evaluate Evaluate a media buy against acceptance policy #
POST /media-buy-approvals/{mediaBuyId}/retry-forward Retry forwarding an approved media buy #
GET /media-buys List every media buy on the storefront #
GET /media-buys/{mediaBuyId}/timeline Get one buy's exchange timeline #
GET /pending-operations List everything waiting on someone #
POST /gam-cleanups/{operationId} Resolve a safe failed GAM order cleanup #
GET /test-runs List recent sandbox test runs #
POST /test-campaigns/plan Plan a sandbox inventory-source test campaign #
POST /test-campaigns/execute Execute a confirmed sandbox inventory-source test campaign #
GET /creative-reviews List creative review queue #
GET /creative-reviews/{creativeId} Get a creative review row #
POST /creative-reviews/{creativeId}/decide Record a decision on a pending creative review #
POST /creative-reviews/{creativeId}/evaluate Evaluate a pending creative review #
GET /publishers List publisher domains #
PUT /publishers Replace publisher list #
POST /publishers Add a publisher domain #
GET /property-roster Get the property roster #
POST /property-roster/properties Declare a property #
DELETE /property-roster/properties/{domain}/{propertyKey} Remove a declared property #
DELETE /publishers/{domain} Remove a publisher domain #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/scope3/refs/heads/main/openapi/scope3-storefront-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/scope3-storefront-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

scope3-storefront-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Scope3 Storefront API
  version: 2.0.0
  description: 'REST API for partners to manage storefronts, inventory sources, and billing.


    ## Authentication


    All endpoints require a Bearer token in the Authorization header:

    ```

    Authorization: Bearer your-api-key

    ```


    ## Base URL


    `https://api.interchange.io/api/v2/storefront`


    ## For AI Agents


    AI agents can use the MCP endpoint at `/mcp/v2/storefront` with three tools:

    - `initialize`: Start an MCP session

    - `api_call`: Make REST API calls

    - `ask_about_capability`: Learn about API features'
servers:
- url: https://api.interchange.io/api/v2/storefront
  description: Production server
tags:


# --- truncated at 32 KB (1308 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/scope3/refs/heads/main/openapi/scope3-storefront-api-openapi.yml