Scope3 Product Discovery API is one of 51 APIs that Scope3 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Product Discovery. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
9 operations
across 7 paths,
and defines 66 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.
The identity and technical contract details declared by the specification.
DiscoveryProductDetail
object
11 properties
2 required
CreateDiscoveryCampaignBody
object
Request body for creating a discovery-mode campaign
18 properties
5 required
DiscoveryTraceDiagnostics
object
Advanced support diagnostics for tracing a discovery fan-out.
3 properties
3 required
PricingOptionData
object
Pricing option from a sales agent
8 properties
SessionProductsResponse
object
Response containing selected products
6 properties
3 required
GetProductsBody
object
Canonical AdCP getproducts request with optional Interchange multi-storefront and buyer-intelligence controls.
20 properties
1 required
FrequencyCapWindow
object
Rolling time window over which maximpressions applies (AdCP Duration shape).
2 properties
2 required
MetricGoal
object
Optimize for a seller-tracked delivery metric. No event source required.
5 properties
2 required
CreateMediaBuysBatchResponse
object
Cart and per-campaign execution outcome for a multi-storefront batch.
15 properties
13 required
PendingDiscoveryAgent
object
A seller still answering during a progressive discovery — it has not settled yet.
3 properties
2 required
ProductCardData
object
Visual card data for rendering a product in UI
5 properties
ApplyProposalRequest
object
Apply a sales agent proposal to auto-add products with recommended budget allocations
3 properties
1 required
BatchMediaBuyCampaign
Use an existing campaign cart, or provide the complete fields for a new DRAFT discovery campaign.
BudgetContextResponse
object
Budget allocation context
4 properties
3 required
DiscoveryRefinementItem
object
A refinement instruction for iterating on discovery results. Scoped to the overall request, a specific product, or a specific proposal.
ProductFormatOptionParams
object
Canonical format params. For hosted video, carries accepted containers/codecs.
3 properties
AgentDiscoveryResult
object
Per-agent discovery result with optional debug info. Same structure as v1 mediaproductdiscover debug output.
12 properties
4 required
ConnectionIssue
object
An adapter connection that requires the buyer to re-authenticate before discovery can reach it.
3 properties
1 required
CreateMediaBuysBatchBody
object
Stage or execute multiple storefront-qualified getproducts selections through one DRAFT campaign cart.
6 properties
4 required
FrequencyCapConfigInput
object
Frequency cap entry supplied inside a parent advertiser/campaign/creative request body. On PUT, the full array replaces all existing caps for that target.
2 properties
2 required
ErrorResponse
object
Standard error response
2 properties
2 required
Product
object
Product resource for campaign inventory
27 properties
2 required
PacingPeriods
object
Defines a pacing schedule for a campaign. Periods represent time windows with varying spend intensity. Gaps between periods are treated as pauses (no spend). U…
2 properties
2 required
AgentDebugLog
object
A single debug log entry from ADCP agent communication
5 properties
EventGoal
object
Optimize for advertiser-tracked conversion events via event sources.
5 properties
2 required
OptimizationApplyMode
string
Whether optimization suggestions are automatically applied or require human approval.
GcsDeliveryConfig
object
3 properties
1 required
DiscoverProductsResponse
object
Response from discovering products
18 properties
5 required
Proposal
object
A recommended media plan with budget allocations across products (ADCP v3)
12 properties
3 required
IncompleteDiscoveryAgent
object
Storefront agent that did not fully complete inside the requested discovery wait window, either because the call timed out locally or because the seller return…
7 properties
4 required
CampaignDataDeliveryInput
object
Campaign-scoped data-delivery configuration. Groups Data Delivery Outputs that override advertiser-scoped delivery for the same dataDeliveryType. Distinct from…
1 property
DataDeliveryOutputInput
object
A single Data Delivery Output entry. Used inline on advertiser/campaign create+update.
6 properties
4 required
OptimizationAttributionWindow
object
Attribution window for conversion optimization
2 properties
1 required
SelectedProduct
object
A product selected for inclusion in a discovery session
11 properties
5 required
OptimizationGoal
object
A single optimization target. Either kind "event" (conversion events) or kind "metric" (seller-native delivery metric).
DeliveryConfig
object
Per-Output destination shape (non-secret). Additional destination types are added as new variants in this discriminated union.
InterchangeProduct
object
Canonical AdCP product with an opaque storefront-qualified identity and attributed Interchange intelligence.
49 properties
8 required
ProposalEvaluationRequest
object
Managed buyer operating instructions for proposal disposition, optional enrichment, bounded refinement, and optional comparative ranking. This is prompt config…
5 properties
1 required
InterchangeProposal
object
Canonical AdCP proposal with storefront-qualified proposal and allocation product identities.
11 properties
4 required
DiscoverProductsBody
object
Request body for discovering products with optional auto-session creation
24 properties
1 required
BatchProposalSelection
object
A storefront-qualified seller proposal selected from getproducts.
3 properties
2 required
ProductCardDetailedData
object
Detailed inline product card data for buyer UIs
7 properties
ApplyProposalResponse
object
Response from applying a proposal
10 properties
7 required
ProductGroup
object
Group of products from a publisher
9 properties
6 required
RemoveProductsRequest
object
Request to remove products from a discovery session
1 property
1 required
IncompleteDiscoveryScope
object
A getproducts scope the upstream seller could not fully complete within the requested time budget.
3 properties
2 required
PerformanceConfig
object
Configuration for performance campaign optimization
1 property
1 required
ProjectedGetProductsResponse
Canonical getproducts response, either complete or with product objects honoring the optional fields projection while retaining qualified identity and Intercha…
ProductFormatOption
object
AdCP 3.1 format declaration for a product
4 properties
Duration
object
A duration expressed as an interval and unit
2 properties
2 required
RefinementApplied
object
Seller's response to a refinement instruction, matched by position to the request's refine array
4 properties
1 required
CampaignUtmConfig
object
UTM configuration for a campaign. Overrides advertiser-level defaults for matching param keys.
2 properties
1 required
GetProductsResponse
object
Canonical flat AdCP product page with Interchange progressive and optional buyer-intelligence metadata.
29 properties
4 required
AzureBlobDeliveryConfig
object
3 properties
1 required
ProductAllocation
object
Budget allocation for a product within a proposal
6 properties
2 required
ProposalScreeningRequest
object
Deprecated compatibility alias for managed proposal evaluation. It enables accept, reject, or refine without enrichment or comparative ranking.
3 properties
1 required
DiscoveryDiagnostics
object
Advanced support diagnostics returned only to elevated/admin contexts.
1 property
ProjectedInterchangeProduct
object
Field-projected canonical product. Requested canonical fields may be present; productid, name, and Interchange provenance are always present.
3 properties
3 required
DataDeliveryOutputArrayInput
array
Array of Data Delivery Outputs for one scope (advertiser or campaign). At most one Output per (dataDeliveryType, credentialName) pair — the same data type can…
DiscoverySummary
object
Summary statistics for the discovery
3 properties
2 required
ProductSelection
object
Product selection for adding to a discovery session
13 properties
1 required
ApiError
object
Structured error object
4 properties
2 required
AddProductsRequest
object
Request to add products to a discovery session
3 properties
1 required
AppliedProposalSummary
object
Summary of the proposal that was applied
3 properties
2 required
BatchProductSelection
object
A storefront-qualified proposal-less product selection from getproducts.
8 properties
2 required
S3DeliveryConfig
object
3 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Scope3 publishes across the network.
