GET
/
api
/
ext
/
v1
/
collection
/
{collectionId}
/
product
/
{productId}

​
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

Authorizations

​
Authorization
string
header
required

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
​
productId
string
required

Query Parameters

​
countryCode
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
​
brand
string | null
required
​
creationStatus
enum<string>
required
Available options:
Pending,
Done,
Error
​
description
string
required
​
descriptionV2
string
required
​
featuredImage
object
required
​
id
string
required
​
isDiscontinued
boolean
required
​
isInStock
boolean
required
​
isPersonalized
boolean
required
​
model
string | null
required
​
options
object[]
required
​
priceRange
object
required
​
shippingRegions
object[]
required
​
slug
string
required
​
status
enum<string>
required
Available options:
Active,
Draft
​
tags
object[]
required
​
title
string
required
​
variants
object[]
required
​
customFields
object
​
errors
object | null
​
hiddenAt
string | null
​
notes
string | null
​
retailPriceRange
object
​
sizeChartImages
object[]
​
sizeChartTable
string | null
List a Collection ProductsUpdate Product