Skip to main content
DELETE
Remove products from selection

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

discoveryId
string
required

Discovery ID

Minimum string length: 1
Example:

"abc123-def456-ghi789"

Body

application/json

Request to remove products from a discovery session

productIds
string[]
required

Legacy product-wide removal. Product IDs remove every matching selection instance; storefront-qualified sf1:... IDs limit removal to that storefront.

Minimum array length: 1
productRefs
object[]

Exact selection references. Include inventorySourceId to remove only one source-qualified base variant.

Minimum array length: 1

Response

Remove products from selection

Response containing selected products

discoveryId
string
required

Discovery ID

products
object[]
required

Selected products in the discovery session

totalProducts
integer
required

Total number of selected products

Required range: -9007199254740991 <= x <= 9007199254740991
budgetContext
object

Budget allocation context

campaignBound
boolean

Whether this discovery session is attached to an active campaign. When false, the products are saved to the session but no active campaign reflects them yet.

campaignWarning
string

Guidance shown only when campaignBound is false: either the session is not attached to any campaign, or the campaign it was attached to has been archived. Pass campaignId for an active campaign (or restore the archived one) so the campaign reflects the products.