GET
/
api
/
ext
/
v1
/
collection
/
{collectionId}
/
products
List a Collection Products
curl --request GET \
  --url https://staging-api.covver.io/api/ext/v1/collection/{collectionId}/products \
  --header 'Authorization: Bearer <token>'
{
  "isPersonalized": true,
  "creationStatus": "Pending",
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "priceRange": {
        "minVariantPrice": 123,
        "maxVariantPrice": 123
      },
      "retailPriceRange": {
        "minVariantPrice": 123,
        "maxVariantPrice": 123
      },
      "options": [
        {
          "name": "size",
          "values": [
            {
              "title": "<string>",
              "colorCode": "<string>",
              "colorCode2": "<string>"
            }
          ]
        }
      ],
      "isInStock": true,
      "isDiscontinued": true,
      "featuredImage": {
        "url": "<string>",
        "lowResUrl": "<string>",
        "width": 123,
        "height": 123
      },
      "errors": {
        "hasLowResolutionElements": true,
        "hasNonCmykElements": true,
        "hasBaseProductIssue": true,
        "hasNonBlackAndWhiteElements": true,
        "isBlank": true,
        "hasOldPrintAreas": true
      },
      "isPersonalized": false,
      "status": "Active",
      "notes": "<string>",
      "customFields": {}
    }
  ],
  "collection": {
    "id": "<string>",
    "deletedAt": "2023-11-07T05:31:56Z",
    "status": "Active",
    "slug": "<string>",
    "title": "<string>",
    "description": "<string>",
    "image": "<string>",
    "imageMobile": "<string>",
    "rewardType": "Coins",
    "personalizationsUsed": [
      "<string>"
    ]
  },
  "count": 123
}

​
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
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

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

Start date in ISO format

​
birthDate
string | null

Birth date in ISO format

Response

200
application/json

Default Response

The response is of type object.