GET
/
api
/
ext
/
v1
/
collection
/
{collectionId}
/
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
Examples:
- Accept-Language: *
- Accept-Language: fr
- Accept-Language: fr-FR
- Accept-Language: fr-FR, fr;q=0.9, en;q=0.8, *;q=0.5

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
headerrequired

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

Headers

accept-language
string

See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language

Path Parameters

collectionId
string
required

Query Parameters

companyId
string
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 | null

Start date in ISO format

birthDate
string | null

Birth date in ISO format

Response

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