Skip to main content
GET
List a Collection Products

Localization (optional)

Use the accept-language header to get translated strings. Supported locales:
  • en-US (default locale)
  • fr-FR
  • fr-CA
  • es-ES
  • es-MX
  • en-AU
  • en-GB

Statuses

Multiple statuses can be sent as comma separated values
For a personalized collection, poll this API with the same data until status !== 'Pending' (~20 seconds)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

collectionId
string<uuid>
required

Query Parameters

countryCode
string
sort
enum<string>
Available options:
priceHighToLow,
priceLowToHigh,
alphabeticalAToZ,
alphabeticalZToA
status
string
firstName
string | null

First name

lastName
string | null

Last name

department
string | null

Work department (e.g. sales)

location
string | null

Work location (site/city/country)

startDate
string<date-time> | null

Start date in ISO format

birthDate
string<date-time> | null

Birth date in ISO format

Response

Default Response

isPersonalized
boolean
required
creationStatus
enum<string>
required
Available options:
Pending,
Done,
Error
data
object[]
required
collection
object
required
count
number
required