Skip to main content
POST
List Collection Products Endpoint

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

merchant_id
string
required
collection_id
string<uuid>
required

Query Parameters

locale
string | null

Body

application/json
locale_id
string | null
market_group_id
string | null
market
string | null
mode
enum<string>
default:auto
Available options:
auto,
search,
preview
search
string | null
Maximum string length: 256
sort_by
string | null
ranking_type
enum<string> | null
Available options:
top,
similar,
complementary
cursor
string | null
limit
integer
default:25
Required range: 1 <= x <= 100
include_metrics
boolean
default:false
included_main_product_ids
string[]
Maximum array length: 2000
excluded_main_product_ids
string[]
Maximum array length: 2000

Response

Successful Response

products
CollectionProduct · object[]
required
next_cursor
string | null
has_more
boolean
default:false
sort_options
SortOptionItem · object[]
stats
ProductListingStats · object | null