Skip to main content
POST
Stage or execute products across storefronts

Authorizations

Authorization
string
header
required

API key or access token

Body

application/json

Stage or execute multiple storefront-qualified get_products selections through one DRAFT campaign cart.

productQueryId
string
required

The ext.interchange.execution_id returned by get_products. It identifies the durable search/refinement record whose qualified selections are being purchased.

Required string length: 1 - 128
campaign
object
required

Use an existing campaign cart, or provide the complete fields for a new DRAFT discovery campaign.

mode
enum<string>
required

stage prepares the selected batch as DRAFT media buys without contacting sellers; execute prepares a new batch once and immediately dispatches it. An unchanged prepared retry dispatches the surviving DRAFTs without rebuilding them.

Available options:
stage,
execute
selections
object[]
required

Whole proposals and/or proposal-less products selected from the product query.

Required array length: 1 - 100 elements

A storefront-qualified seller proposal selected from get_products.

replace
boolean
default:false

Replace the cart selections before applying this batch. False merges idempotently with existing selections.

debug
boolean
default:false

Include per-media-buy request/response diagnostics when mode is execute.

Response

Stage or execute products across storefronts

Cart and per-campaign execution outcome for a multi-storefront batch.

productQueryId
string
required
campaignId
string
required
campaignCreated
boolean
required
mode
enum<string>
required
Available options:
stage,
execute
campaignStatus
string
required
queryProductsSelected
integer
required

Current selected-product count in this product query. Use the media-buy references or get_campaign for the complete campaign cart.

Required range: 0 <= x <= 9007199254740991
proposalsApplied
integer
required
Required range: 0 <= x <= 9007199254740991
mediaBuysStaged
integer
required
Required range: 0 <= x <= 9007199254740991
mediaBuysExecuted
integer
required
Required range: 0 <= x <= 9007199254740991
mediaBuyRefs
object[]
required

Lightweight references to current media buys in the campaign cart, capped at 100 to keep the response agent-sized.

Maximum array length: 100
mediaBuyRefsTruncated
boolean
required

True when the campaign has more than 100 current media buys; use get_campaign to page/drill into the campaign.

success
boolean
required
noOp
boolean
required
errors
object[]
warnings
string[]

Non-blocking notices about this batch, e.g. the campaign pacing schedule has no periods covering today or later and needs re-planning before staged buys can execute.