Skip to main content
POST
Search Affiliate Discovery Products

Authorizations

x-api-key
string
header
required

Body

application/json
query
string | null

Free-text query string.

Minimum string length: 1
criteria_set_ids
string[]

Saved criteria set IDs to apply to this first-page search.

exclude_query
string | null

Negative free-text provider filter applied to 'name||description||brand'.

Minimum string length: 1
criteria
(AnyCriterion · object | NameDescriptionBrandCriterion · object | BrandCriterion · object | CategoryCriterion · object | ColorCriterion · object | ConditionCriterion · object | CountryCriterion · object | GenderCriterion · object | GenreCriterion · object | ManufacturerCriterion · object | MaterialCriterion · object | ModelCriterion · object | PublisherCriterion · object | SizeCriterion · object | SubtitleCriterion · object | TagsCriterion · object | CurrencyCriterion · object | OnSaleCriterion · object | SaleDiscountCriterion · object | RegularPriceCriterion · object | FinalPriceCriterion · object | SalePriceCriterion · object | ShipPriceCriterion · object | IdCriterion · object | BarcodeCriterion · object | SkuCriterion · object | MpnCriterion · object | AsinCriterion · object | MerchantIdCriterion · object | MerchantNameCriterion · object | SellerPartyCriterion · object | MerchantCategoryIdsCriterion · object | InStockCriterion · object | StockQuantityCriterion · object | AvailabilityCriterion · object)[]

Structured filters applied in addition to the free-text query.

Example:
per_page
integer
default:25

Maximum number of products requested for the page.

Required range: 1 <= x <= 100
cursor
string | null

Opaque cursor returned by a previous search response.

Response

Successful Response

query
string
required
page_index
integer
required
page_size
integer
required
items
AffiliateDiscoverySearchItem · object[]
required
next_cursor
string | null
expires_at
string<date-time> | null