Scope3 Storefront API
Manage storefront and inventory sources
Scope3 Storefront API is one of 51 APIs that Scope3 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Storefront. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 159 operations across 135 paths, and defines 260 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/storefront.
159 operations
135 paths
260 schemas
10 DELETE63 GET6 PATCH65 POST15 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Scope3 Storefront API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
bearerAuth— API key or access token
Paths & Operations 159
Across 135 paths, the API surfaces 159 operations — 10 DELETE, 63 GET, 6 PATCH, 65 POST, 15 PUT. Each is listed below with its method, path, parameters, and response codes.
Storefront 159
Manage storefront and inventory sources
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 (APIPUSH, 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
Schemas 260
The contract defines 260 schemas that model the data the API accepts and returns. The most detailed are StorefrontResponse (45 properties), IntelligenceRunResponse (29 properties), InventorySourceResponse (28 properties), InventorySourceWorkItem (24 properties). Each schema is shown below with its type and property counts.
UpdateInventorySourceWorkItemBody
object
Updates assignment, status, notes, or intermediate result metadata for a modular inventory source work item. Use the complete endpoint for completion.
5 properties
DemandInboxRow
object
15 properties
15 required
EvaluateCreativeReviewBody
object
Request body for advisory AI evaluation of a pending storefront creative review.
3 properties
CreateOperatingInstructionsBody
object
Request body for creating a new operating-instructions version and optionally activating it atomically.
4 properties
1 required
SaveModularSourceModuleCredentialBody
object
Create or rotate a storefront-scoped credential for one private inventory-source module.
5 properties
1 required
IntelligenceRunProductExplanation
object
Buyer-safe explanation of one product selected for the storefront response.
8 properties
8 required
InventorySourceDiscoveryTestBody
object
Input for a read-only, no-spend getproducts diagnostic against one external sales-agent source.
1 property
FeedContractId
string
Feed contract identifier. static-avails-feed:v1 for static avails CSV/JSON; wholesale-avails-pricing:v1 for wholesale pricing grids.
DemandExchangeRevisionComposeError
object
2 properties
2 required
RecordDemandInboxResultBody
object
Records the seller-authored ledger annotations (grade, buyer feedback, led-by attribution) on one demand-inbox row.
3 properties
StorefrontPendingOperationsResponse
object
The union of things waiting on someone: pending approvals, pending creative reviews, failed forwards (grouped by error code), async-pending source acceptance,…
6 properties
InventorySourceRuntimeProjection
object
Operator-facing setup-state projection for a modular inventory source.
6 properties
5 required
ApiError
object
Structured error object
4 properties
2 required
PendingOperationsSourceDegradationItem
object
One seller-owned source-health diagnosis (docs/spec/storefront/source-diagnosis-projection.md) — a projection of the same diagnoses array the readiness checkli…
4 properties
4 required
SellerMediaBuyStatus
string
Coarse seller-facing lifecycle of a buy on the storefront, derived from persisted approval + forwarding state. A platform list-view convenience — not an AdCP M…
StorefrontPricingFactHints
object
Optional best-effort hints for matching a seller pricing fact. These are not product assembly rules; the Merchandising Agent still reasons over the natural-lan…
8 properties
StorefrontSellerAnalyticsResponse
object
Seller-facing analytics rollup over a window of recent intelligence runs: summary KPIs, commercial outcomes, posture conversion with recommendation-adherence,…
15 properties
15 required
FeedPushBody
object
Request body for POST /inventory-sources/:sourceId/feed/push (APIPUSH one-shot ingest).
8 properties
1 required
DemandInboxResponse
object
The demand-inbox ledger: a persisted-only metrics strip, a page of brief → proposal → feedback → result rows, and the total brief count for page-cap disclosure.
3 properties
3 required
SellerTimelineEvidence
object
One observed fact supporting a timeline stage.
9 properties
9 required
ErrorResponse
object
Standard error response
2 properties
2 required
DemandInboxMetrics
object
Front-of-house scoreboard. Every field is computed only from persisted rows; a metric with no inputs reports null (unavailable), never 0.
6 properties
6 required
ManagedSalesAgentSummary
object
Read-only managed ad-server source state for inventory sources with executionType=MANAGEDSALESAGENT.
8 properties
8 required
CompleteInventorySourceWorkItemBody
object
Completes a modular inventory source work item and applies any completion side effects required by the module contract.
2 properties
ResolveHouseResponse
object
A domain resolved up its corporate hierarchy for authoring.
7 properties
7 required
SellerTimelineStage
object
One reached stage of the exchange, with evidence.
4 properties
4 required
DemandExchangeRunPurpose
string
The compose run's own trusted execution classification. 'live' (or the historical 'unclassified' sentinel) is real buyer demand; every other value — including…
InventorySourceWorkItemSummary
object
Summary of a seller-facing modular inventory source work item. Fetch the detail endpoint for module payload and result metadata.
23 properties
22 required
ResolveGamCleanupBody
Explicitly confirm safe archival, or record that the order was cleaned up manually in GAM.
InventorySourceWorkItemMutationResponse
object
3 properties
2 required
EsaCapabilityRecheckResult
object
Result of explicitly re-checking a separately provisioned ad-server capability. A successful check may resume the paused sync for that capability.
8 properties
8 required
MediaBuyPendingReason
string
Why a not-yet-delivering media buy is waiting, and implicitly whose side owns the wait. A platform-derived annotation — never a status value. awaitingstorefron…
ModularSourceModuleCredentialResponse
object
Non-secret lifecycle metadata for one inventory-source module credential.
1 property
1 required
EsaSyncHistoryResponse
object
Historical sync-run timeline for operator drill-down from coarse status.
3 properties
3 required
IntelligenceRunExplanation
object
Sanitized, user-facing explanation derived from the persisted run record: selected products, reasoning, pricing notes, buyer-instruction effects, and failures.
6 properties
6 required
StorefrontPricingFactPrice
object
Value-pricing anchor extracted from seller rate cards, media kits, or operator instructions.
5 properties
BriefArtifact
object
The canonical inbound brief: the exact validated AdCP request, content-addressed and immutable.
13 properties
13 required
DemandExchangeBudgetRange
object
The buyer's stated budget range, exactly as sent in the brief's filters.budgetrange. Null when the buyer did not state one.
3 properties
3 required
DemandCoverageSampleBrief
object
Representative starter-brief combination for seller demand coverage.
5 properties
5 required
GamAdServerConfig
object
Google Ad Manager configuration. Per-customer service-account credentials are managed by Scope3 (publisher grants access in their GAM admin console).
3 properties
2 required
CreativeReviewStatus
string
Lifecycle state of a buyer-submitted creative awaiting storefront review. pending until an operator decides; approved or rejected after a decision; revoked if…
EsaSetupTaskItem
object
A single configuration-completeness item from the upstream managed-source status feed.
7 properties
6 required
PendingMediaBuyListResponse
object
List response for the operator approval queue.
2 properties
2 required
IntelligenceRunPurpose
string
Trusted execution classification. Null is reserved for historical runs recorded before purpose was required.
GetProposalArtifactResponse
object
1 property
1 required
OperatingInstructionsListResponse
object
List of operating-instructions versions for a storefront.
2 properties
2 required
SourceRecheckAction
object
Portable named operation for re-running a source-health check. Hosts resolve method and path from the canonical operation registry; deprecated method/path fiel…
AcceptancePolicyResponse
object
A single acceptance-policy version for a storefront. Versions are immutable; updates produce a new row.
8 properties
8 required
StorefrontResponse
object
Storefront configuration response
45 properties
40 required
RefreshComplianceBody
object
Request body for re-running the storefront compliance check.
1 property
OperatingInstructionsResponse
object
A single operating-instructions version for a storefront. Versions are immutable; updates produce a new row.
10 properties
10 required
StorefrontPricingFact
object
Lightly structured seller value-pricing fact. Pricing facts anchor prices and floors; they are not product assembly templates.
8 properties
4 required
LinkedStorefrontSummary
object
Retired. Never populated — storefront interchange runs through the ambient wholesale pool, so no inline link state is produced. Retained as a reserved, always-…
9 properties
9 required
SellingDoctrineSetThresholds
object
1 property
1 required
BuyerInstructionsListResponse
object
List of buyer-instructions rows for a storefront.
2 properties
2 required
SourceDetailAction
object
Server-selected portable specialist surface for one inventory source. The operation discriminant fixes the exact validated arguments shape.
InventorySourceMappingWorkspaceResponse
object
Mode-aware, source-scoped mapping workspace. Shared identity counts are Storefront projections; source and mapped counts never imply coverage by another Source.
4 properties
4 required
BuyerAutoApproveResponse
object
A single per-buyer media-buy auto-approve override.
13 properties
13 required
SubmitDemandExchangeRevisionBody
object
Submit a draft for approval, or clear it immediately when the storefront/buyer auto-approve dial covers it. expectedSubmissionGeneration must match the draft's…
1 property
1 required
CatalogMappingAction
object
One portable, validated V2 operation. The same action is projected to Modular Source and Seller Setup.
InventorySourceWorkItemDetailResponse
object
2 properties
2 required
StorefrontCompositionPricing
object
Storefront composition pricing settings: fallback guidance percentile plus lightly structured seller pricing facts.
2 properties
FeedPreviewBody
object
Request body for POST /inventory-sources/:sourceId/feed/preview.
7 properties
1 required
DemandExchangeFedBy
object
9 properties
9 required
SourceHealthDiagnosis
object
One typed source-health diagnosis: what failed, who owns the fix, how much it matters to this storefront, and the inline action.
11 properties
11 required
DemandExchangeRevisionSend
object
How a sent revision cleared. Null until sent. An auto send never carries a human decision record.
2 properties
2 required
InventorySourceDiagnosticsResponse
object
Seller-facing diagnostics for a single third-party sales-agent or modular inventory source.
13 properties
13 required
FeedPushResponse
Response from POST /feed/push. When dryRun is true or the revision is REJECTED, only revision is returned. Otherwise feedId, sourceId, revision, and revisionRe…
EsaPricingCoverageSummary
object
Per-product wholesale pricing coverage. Ad-server and manual pricing may coexist; unresolved active products need manual fallback before they are buyer-visible.
7 properties
7 required
IngestModularAvailsFeedBody
object
Previews or upserts avails through the production static-avails-feed:v1 compatibility parser; this is not the target Inventory Feed schema. Every legacy compat…
13 properties
InventorySourceContractField
object
Field declared by a modular inventory source contract.
9 properties
7 required
StorefrontApprovalPolicyDecision
string
Policy confidence for storefront approval automation. definitelyonpolicy is eligible for automatic approval, definitelynotonpolicy is a clear policy conflict,…
ProposalArtifactListResponse
object
Proposal artifacts for a storefront, newest first.
2 properties
2 required
BuyerAutoApproveListResponse
object
Per-buyer media-buy auto-approve overrides plus the storefront-scoped buyers eligible for a new override.
3 properties
3 required
CreativeReviewEvaluationResponse
object
Advisory AI evaluation for a storefront creative review row. Evaluation does not approve or reject the creative.
9 properties
9 required
SellingDoctrineAdoptVariant
object
1 property
1 required
SellerRecoveryAction
string
Which action class applies: retry (transient failure, not terminalized — the platform can re-attempt), forceretry (a source refused the buy and the platform te…
EsaConnectionList
array
All managed ad-server source connections owned by this storefront.
FinalizeModularInventoryBookingBody
object
Prepares a held modular inventory reservation for the source execution handoff. Cadent sources render Cadent XML; FreeWheel sources create source-side HITL wor…
8 properties
3 required
MediaBuyApprovalEvaluationResponse
object
Brief Acceptance evaluation for a storefront media buy on the manual approval path. Definitely-on-policy buys auto-forward; ambiguous, failed, and hard finding…
8 properties
8 required
ComplianceTrackResult
object
Result for a single compliance track
5 properties
4 required
SellerPayloadHighlights
object
Trafficker-grade highlights extracted from the forwarded payload: flight, budget, packages, targeting dimensions.
7 properties
7 required
SellerAccountGrantReviewDecision
object
12 properties
7 required
CreativeReviewDecisionStatus
string
Terminal statuses an operator can set via the decide endpoint. revoked is handled separately and is not a valid decide-time value.
UpdateBuyerInstructionsBody
object
Partial update for a buyer-instructions row. Scope (operatorDomain, brandDomain) is immutable — delete and recreate to change it.
3 properties
HouseDiscountResponse
object
A single house-scoped buyer-discount row.
9 properties
9 required
EsaTenantStatus
object
Operational snapshot of a managed ad-server source: adapter health, sync state, workflows, packages, creatives, webhook stats.
15 properties
8 required
RetryForwardMediaBuyResponse
object
An approval-queue entry returned from a retry-forward attempt, carrying the outcome of the dispatch when one ran.
15 properties
13 required
AcceptancePolicyListResponse
object
List of acceptance-policy versions for a storefront.
2 properties
2 required
ProposalArtifact
object
The canonical outbound proposal: exact response envelope + immutable product snapshots, with brief/run lineage.
15 properties
15 required
CatalogMappingReadiness
object
Tenant-scoped, read-only per-source catalog-mapping readiness derived from existing owners.
3 properties
3 required
EsaSetupTasksBlock
object
Configuration-completeness rollup from the upstream managed-source status. Storefront merges these with its own platform-managed task list.
3 properties
3 required
SellerAccountBindingFeedCommitResult
object
6 properties
6 required
BuyerInstructionsResponse
object
A single buyer-instructions row.
10 properties
10 required
ResolveBrandResponse
object
13 properties
2 required
DemandExchangeGrouping
object
4 properties
4 required
InventorySourceModuleRuntimeProjection
object
Runtime setup state for one module on a modular inventory source.
18 properties
18 required
IntelligenceRunListResponse
object
List of intelligence runs for a storefront.
2 properties
2 required
FeedUploadBody
object
Multipart form-data body for POST /inventory-sources/:sourceId/feed/upload. Send the feed file as the file part and the remaining fields as form text fields. F…
5 properties
2 required
EsaOperationalStatus
object
Derived private uptime-style state for a managed ad-server source. Local provisioning state is lifecycle bookkeeping; this status is computed from upstream sta…
5 properties
5 required
CreateHouseDiscountBody
object
Request body for creating a rate-card discount on the brand or operator axis. (housedomain, scope) is unique per storefront — a duplicate fails with a conflict…
4 properties
4 required
InventorySourceResponse
object
Inventory source response
28 properties
8 required
MerchandisingSimulationJsonValue
Any JSON value captured verbatim in simulation evidence.
OnboardingPlanStep
object
2 properties
2 required
CreativeReviewListResponse
object
List response for the operator creative review queue endpoint.
2 properties
2 required
StorefrontPublisherDomainReadiness
object
One configured publisher domain with its latest AAO/adagents.json authorization and managed-sales-agent synchronization evidence.
8 properties
8 required
InventorySourceWorkItemsResponse
object
4 properties
4 required
CreateCitrusAdModularSourceBody
object
Connects CitrusAd using the standard sponsored-products composition. API credentials are stored separately through the CitrusAd ad-server credential endpoint.
7 properties
4 required
EsaServiceAccountResponse
object
1 property
1 required
SellerTimelineStageName
string
Lifecycle stage of a buy exchange as seen from the storefront: received → screened → decided → forwarded / forward-failed → submitted → source moderation → acc…
EsaSyncHistoryRun
object
One historical sync run from the managed ad-server source.
10 properties
10 required
CreateStorefrontBody
object
Request body for creating a storefront
8 properties
1 required
StorefrontMediaBuyListResponse
object
Every buy on the storefront — the union of routed and source-managed buys — urgency-sorted by default.
4 properties
4 required
DecideSellerAccountGrantReviewBody
object
Approve a buyer account into an existing seller-native ad-server record (linkexisting, with operator- or advertiser-cleared billing and the seller-declared bil…
FeedCommitResponse
object
Response from POST /feed/commit. The revision is now COMMITTED and the feed head has advanced.
4 properties
4 required
InventorySourceModuleContractSummary
object
Versioned contract summary used to interpret a modular source module.
9 properties
7 required
FreeWheelInventorySelectorPageResponse
object
3 properties
3 required
InventorySourceDiscoveryTestResponse
object
Normalized result of a direct, read-only getproducts diagnostic against one third-party sales-agent source.
11 properties
11 required
LaunchEsaBody
object
Optional deep-link target for a managed ad-server source launch URL.
1 property
FeedPreviewBaseline
object
Signed preview baseline. Pass it back unchanged to POST /feed/commit.
13 properties
13 required
CitrusAdModularSourceResponse
object
Seller-facing CitrusAd ad-server connection. Internal recipe modules are intentionally not exposed.
7 properties
7 required
EsaAdapterCapabilityCheck
object
One adapter capability probe result. Mutating capabilities may be reported as notchecked by non-mutating connection tests.
6 properties
2 required
IntelligenceRunBuyerScope
object
Buyer scope extracted from the AdCP getproducts request that drove this run.
3 properties
3 required
OnboardingPhaseTransition
object
3 properties
3 required
MediaBuyDecisionBody
object
Request body for recording an operator decision on a pending media buy.
2 properties
1 required
AdsWizzAdServerConfig
object
AdsWizz Domain API v8 (streaming audio + podcast) adapter configuration. The static API key is forwarded to the managed ad-server source and never persisted on…
10 properties
3 required
CreativeReviewResponse
object
A single creative review queue row — one buyer-submitted creative awaiting (or having received) an operator decision.
12 properties
12 required
SellerAccountBindingFeedPrepareResult
object
7 properties
7 required
PendingOperationsApprovalItem
object
One media buy waiting on operator approval.
4 properties
4 required
IngestModularAvailsFeedResponse
object
7 properties
FreeWheelAdServerConfig
object
FreeWheel Publisher API adapter configuration. Credentials are forwarded to the managed ad-server source and never persisted on the local connection row.
10 properties
1 required
ExchangeArtifactRedactionManifest
object
Discloses exactly what was removed or dropped from the stored payload.
2 properties
1 required
SellerAccountGrantReviewList
object
2 properties
2 required
IntelligenceRunBuyerInstructions
object
Resolver output: which buyer-instructions rows matched and the effective discount + notes applied.
3 properties
3 required
DemandExchangeBriefFacts
object
Condensed brief facts read from the persisted brief artifact request (never reconstructed). Any field the buyer did not send is null.
5 properties
5 required
DemandExchangePitch
object
The composed argument for one pass: what we heard, the thesis, the plan as roles with per-product fit arguments, outcome linkage, the value case, the honest co…
11 properties
11 required
ModularInventoryProduct
object
Product-like projection of one normalized modular inventory avail.
20 properties
20 required
FeedRevisionRecord
object
8 properties
8 required
InventorySourceWorkItemEvent
object
8 properties
8 required
InventorySourceWorkItem
object
Seller-facing work item for a modular inventory source lifecycle task.
24 properties
24 required
DemandCoverageSummary
object
Seller-side starter-brief coverage derived from profile, markets, channels, and product evidence.
7 properties
7 required
ResolveBrandBody
object
1 property
1 required
AdServerConfigView
object
Non-secret view of the connection ad-server config. Returned by GET endpoints; never contains credentials.
PatchStorefrontCapabilitiesBody
object
Request body for patching legacy capability configuration and/or recording selling intent. Effective product composition is Source-derived even though V2 prese…
2 properties
PendingMediaBuyResponse
object
A single pending media-buy entry on a storefront approval queue.
13 properties
13 required
DemandExchangeProduct
object
10 properties
10 required
DemandExchangeRevision
object
A seller-composed adjustment to a live demand exchange: silent while draft or awaiting approval, and a real pass on the exchange's compose run once sent.
22 properties
22 required
FeedPreviewResponse
object
Response from POST /feed/preview and POST /feed/upload. Pass previewBaseline and revision to POST /feed/commit.
4 properties
4 required
InventorySourceLifecycleStageSummary
object
Source-level lifecycle summary for a modular inventory source, aggregating setup gaps, runtime input requirements, HITL state, and module issues by stage.
13 properties
13 required
DemandExchangePassOutcome
object
Commercial outcome attributed to this pass. Today one run backs an exchange, so every pass shares the run-level outcome.
2 properties
2 required
CreateCadentDemoModularSourceBody
object
Creates or resets a demo modular inventory source backed by static avails, a booking ledger, and Cadent execution.
5 properties
UpdateModularSourceModuleConfigBody
object
Update non-secret configuration for a module on a modular inventory source.
3 properties
1 required
StorefrontMediaBuySummary
object
One buy on the storefront, at the seller list grain.
16 properties
16 required
SpringServeAdServerConfig
object
SpringServe (Magnite) adapter configuration. Credentials are forwarded to the managed ad-server source and never persisted on the local connection row.
8 properties
1 required
StorefrontPricingFactOutput
object
Lightly structured seller value-pricing fact. Pricing facts anchor prices and floors; they are not product assembly templates.
8 properties
6 required
SellerAccountBindingFeedPreviewResult
object
10 properties
10 required
BusinessProfile
object
Operator-supplied business profile captured by Murph during storefront setup.
11 properties
FreeWheelSandboxModularSourceResponse
object
3 properties
3 required
EsaWholesalePricingMode
string
Legacy source-level pricing preference. Product-level coverage is authoritative: ad-server-priced products are preserved and manual uploads fill only unresolve…
FeedCommitBody
object
Request body for POST /inventory-sources/:sourceId/feed/commit.
3 properties
3 required
CreateFreeWheelSandboxModularSourceBody
object
Creates or updates a FreeWheel sandbox modular inventory source. Credentials are platform-managed sandbox environment variables, not caller-supplied secrets or…
3 properties
PendingOperationsFailedForwardItem
object
One buy whose forward failed, with its gated action.
6 properties
6 required
IntelligenceRunProductPricingExplanation
object
Server-computed CPM pricing summary for a selected composition.
4 properties
4 required
DemandExchangePitchClaim
object
4 properties
4 required
PendingOperationsFailedForwardGroup
object
Failed forwards grouped by structured error code.
5 properties
5 required
ReadinessCheck
object
Individual readiness check result
16 properties
6 required
CreateFeedModularSourceBody
object
Creates a real seller modular inventory source backed by an uploaded/static avails feed module and, by default, the built-in booking ledger. Execution, reporti…
9 properties
1 required
RetryForwardMediaBuyBody
object
Request body for retrying forwarding. The terminal override is an operator recovery control and is guarded against duplicate upstream writes.
2 properties
EsaInventorySync
object
Cached inventory-sync state for this managed ad-server source. Updated by the /webhooks/esa-sync receiver when the upstream service emits syncrun.completed / s…
6 properties
6 required
StorefrontMediaBuyTimelineResponse
object
The seller-scoped projection of a buy's exchange timeline: only this storefront's legs; forwarded/response payloads minus platform-internal fields; no admin-on…
6 properties
6 required
StorefrontTargetEntry
object
One discovered entry in a storefront onboarding plan target model.
7 properties
7 required
SellerDecisionRecord
object
Canonical seller-readable decision record projected from one storefront intelligence run and its attributed approval/commercial evidence.
13 properties
13 required
SourceDiagnostics
object
Per-inventory-source diagnostics for storefront setup and onboarding
21 properties
18 required
PropertyRosterResponse
object
The storefront property roster: every declared publisher domain with its resolved properties, canonical AdCP Collections, canonical creative formats, and autho…
4 properties
4 required
BusinessProfileOutput
object
Operator-supplied business profile captured by Murph during storefront setup.
11 properties
EsaRefreshResult
object
Result of manually refreshing a managed ad-server source. alreadyrunning is informational and carries the upstream syncrunids for correlation.
4 properties
3 required
StorefrontLiveness
object
The projected storefront liveness verdict (AI-4698) — one derived status computed centrally and consumed by readiness, the seller-setup widget, and the storefr…
5 properties
5 required
InventorySourceContractFieldGroup
object
Contract fields grouped by source.
2 properties
2 required
ReserveModularInventoryProductBody
object
Holds capacity against one modular inventory product projection. One of productId or availId is required.
7 properties
3 required
PostCreativeReviewDecisionBody
object
Request body for the operator decide endpoint. Records a terminal decision against a pending creative review row.
2 properties
1 required
UpdateHouseDiscountBody
object
Partial update for a rate-card discount. Only discountPercent and notes are mutable; housedomain and scope are immutable — delete and recreate to change either.
2 properties
StorefrontCompositionPricingOutput
object
Storefront composition pricing settings: fallback guidance percentile plus lightly structured seller pricing facts.
2 properties
2 required
StorefrontCapabilities
object
Which AdCP capabilities the storefront advertises to buyers. Product composition is derived from Source product-path readiness and entitlement.
3 properties
3 required
SetBuyerAutoApproveBody
object
Enable or disable per-buyer media-buy auto-approve for one buyer. The storefront is resolved from the operator's auth context, never the request body.
2 properties
1 required
InventorySourceLifecycleProjection
object
Setup-state projection for one lifecycle stage of a modular source module. This is configuration completeness, not a guarantee that runtime inputs, HITL work,…
9 properties
7 required
BriefArtifactSummary
object
Brief artifact without the request payload (list view).
12 properties
12 required
DecideDemandExchangeRevisionBody
object
Approve or reject a revision awaiting approval. expectedSubmissionGeneration must match the revision's current submissionGeneration (as read) — a stale generat…
3 properties
2 required
SellerAccountMappingExport
object
6 properties
6 required
CadentDemoModularSourceResponse
object
4 properties
4 required
IntelligenceRunProductFormatExplanation
object
Creative format selected for an explained product.
2 properties
2 required
DemandExchangePitchRole
object
3 properties
3 required
SellerAccountMappingList
object
3 properties
3 required
FreeWheelInventoryCapabilitiesResponse
object
5 properties
5 required
CreativeReviewEvaluationAnswer
object
Answer to an operator-supplied creative review question.
3 properties
2 required
FinalizeModularInventoryBookingResponse
object
6 properties
3 required
StorefrontOnboardingPlan
object
Durable per-storefront onboarding plan: target model + step-completion + phase-transition history.
6 properties
6 required
ManagedSourceAccountRefreshResult
object
5 properties
5 required
HouseDiscountListResponse
object
List of house-scoped buyer-discount rows for a storefront.
2 properties
2 required
FeedRevisionEnvelope
object
Inventory feed revision envelope returned by preview, upload, commit, and push endpoints. Matches the InventoryFeedRevisionSchema contract.
19 properties
13 required
GetBriefArtifactResponse
object
1 property
1 required
IntelligenceRunUnpricedProductExplanation
object
Composition the model considered but the platform omitted because it could not be priced authoritatively.
5 properties
5 required
BriefArtifactListResponse
object
Brief artifacts for a storefront, newest first.
2 properties
2 required
SellerAccountBindingFeedRevision
object
11 properties
11 required
AmendDemandExchangeRevisionBody
object
Re-declare posture, price, and product-count overrides and re-compose a draft revision in place through the real merchandising engine. Valid only against a dra…
1 property
1 required
SellerAccountMappingSource
object
4 properties
4 required
DiscoverAgentsResponse
object
3 properties
3 required
IntelligenceRunResult
object
Outcome envelope: ok on success, error with code/message on failure, skipped when the pipeline short-circuited.
3 properties
3 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
SellingDoctrineThresholds
object
3 properties
3 required
EsaCanonicalProductFormatOption
object
URL-free AdCP 3.1 product format declaration. Canonical formats use formatkind plus params and never agenturl; publisher-backed options pair formatoptionid wit…
4 properties
2 required
LaunchEsaResponse
object
Minted launch URL for the managed ad-server source admin UI.
1 property
1 required
AdServerConfig
object
Discriminated union of supported ad-server configurations. Includes credentials for adapter types that authenticate with publisher-supplied credentials (FreeWh…
InventorySourceModuleTaskContract
object
Runtime task contract emitted by a modular inventory source module for operator and Murph work queues.
14 properties
10 required
ModularInventoryProductsResponse
object
1 property
1 required
ModularAvailsPreview
object
9 properties
9 required
SourceForwardResult
object
Per-source outcome of one forwarding leg.
3 properties
2 required
DiagnosisAction
Typed inline action: recheck carries a portable named operation, reconnect opens the ad-server connect task, open opens a focused setup surface, none means not…
PrepareSellerAccountBindingFeed
object
5 properties
4 required
CreateAcceptancePolicyBody
object
Request body for creating a new acceptance-policy version and optionally activating it atomically.
3 properties
1 required
LabelIntelligenceRunBody
object
Attach (or replace) an evaluator label on an intelligence-run row. The label is freeform JSON the eval workflow defines.
1 property
1 required
ProposalArtifactSummary
object
Proposal artifact without the response/snapshot payloads (list view).
13 properties
13 required
SellerAccountMappingSummary
object
3 properties
3 required
PendingOperationsAwaitingSourceItem
object
One buy the source accepted asynchronously and is still moderating.
6 properties
6 required
SellerForwardOutcome
string
How far forwarding to the underlying source(s) got: notforwarded (nothing dispatched yet), allcompleted (every source accepted inline), allsubmitted (every sou…
StorefrontReadinessResponse
object
Storefront readiness assessment
14 properties
11 required
DemandExchange
object
The full story of one brief → proposal → result exchange: brief facts, ordered passes with product allocation + pricing rows, per-pass outcome, and an exchange…
23 properties
23 required
DemandExchangeBidDecision
object
7 properties
7 required
SellerAccountGrantReviewItem
object
10 properties
10 required
AgentComplianceResult
object
Compliance assessment for a single agent
8 properties
7 required
ReleaseModularInventoryBookingBody
object
Releases a held modular inventory reservation or cancels a locally booked reservation.
4 properties
3 required
ReserveModularInventoryProductResponse
object
6 properties
6 required
LearnedDefaultPostureResponse
object
The storefront learned default posture after a pin or clear operation.
1 property
1 required
UploadModularAvailsFeedBody
object
1 property
1 required
ComposeDemandExchangeRevisionBody
object
Declare posture, price, and product-count overrides in the merchandising simulator's own grammar and compose a silent draft revision through the real merchandi…
1 property
1 required
ReadinessBlockingGuidance
object
Canonical cause, buyer-path effect, evidence, and resolution for an incomplete hard readiness requirement.
7 properties
6 required
IntelligenceRunNegotiationAnalytics
Compact seller-facing analytics derived from the buyer request and storefront response: refine counts, ask categories, product ids shown, and acknowledgement c…
CreateBuyerInstructionsBody
object
Request body for creating a buyer-instructions row. (operatorDomain, brandDomain) is unique per storefront — duplicate scopes fail with a validation error; use…
5 properties
5 required
UpdateInventorySourceBody
object
Request body for updating an inventory source. Only the documented fields are writable. Unknown v2 extension keys are tolerated and ignored solely for legacy c…
9 properties
EsaCapability
string
Separately provisioned ad-server capability that can be re-checked.
DemandExchangeRevisionApproval
object
4 properties
4 required
SetLearnedDefaultPostureBody
object
Pin or clear the storefront learned default negotiation posture.
1 property
1 required
SellerAccountMappingCoverage
object
9 properties
9 required
EsaTestConnectionResponse
object
Result of probing the upstream managed ad-server source for reachability.
7 properties
3 required
FeedModularSourceResponse
object
3 properties
3 required
CommitSellerAccountBindingFeed
object
3 properties
2 required
SellerTimelineLeg
object
One source leg of the buy, as seen from the storefront.
14 properties
14 required
StorefrontPricingFactHintsOutput
object
Optional best-effort hints for matching a seller pricing fact. These are not product assembly rules; the Merchandising Agent still reasons over the natural-lan…
8 properties
SellerAccountMappingItem
object
7 properties
7 required
IntelligenceRunResponse
object
A single storefront intelligence run: inputs, prompt, raw + parsed LLM output, persisted product ids, and result envelope.
29 properties
29 required
StorefrontPricingFactPriceOutput
object
Value-pricing anchor extracted from seller rate cards, media kits, or operator instructions.
5 properties
1 required
EsaOperationalIssue
object
A derived private operational issue for the managed ad-server source. These issues are computed by Interchange from the upstream status feed and are intended f…
5 properties
4 required
BuyerAutoApproveEligibleBuyer
object
A storefront-scoped buyer that is eligible for a per-buyer auto-approve override.
4 properties
4 required
SellingDoctrineResponse
object
The doctrine an operating-instructions version carries, always resolved: a version with none reads the platform default with isDefault: true, so a reader never…
3 properties
3 required
SellingDoctrineBody
The selling doctrine to store on this version. Either adopt one of the three named strategies — 'premiumscarcityhouse' (qualify hard, pass often, hold price),…
DemandExchangePass
object
19 properties
19 required
SourceCardPosture
object
Server-owned seller posture for one source card. This is a bounded presentation verdict, not a universal source readiness boolean.
PendingOperationsCreativeReviewItem
object
One creative waiting on operator review.
4 properties
4 required
EsaConnection
object
Storefront → managed ad-server source connection. A storefront can have multiple connections, each addressed by id.
15 properties
15 required
ExchangeArtifactPaginationMeta
object
Offset pagination envelope shared by the list endpoints.
1 property
1 required
OnboardingPhase
string
Seller onboarding phase, derived live from setup-mode + readiness: passthrough (a finished-products sales agent — no rungs) or the Crawl → Walk → Run progressi…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Scope3 12
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
#Storefront
Where this information came from
This is an independent, third-party profile of Scope3 Storefront 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.