GET
/
api
/
ext
/
v1
/
collection
/
{collectionId}
/
product
/
{productId}
curl --request GET \
  --url https://staging-api.covver.io/api/ext/v1/collection/{collectionId}/product/{productId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "hiddenAt": "2023-11-07T05:31:56Z",
  "title": "<string>",
  "model": "<string>",
  "brand": "<string>",
  "notes": "<string>",
  "status": "Active",
  "slug": "<string>",
  "description": "<string>",
  "descriptionV2": "<string>",
  "sizeChartTable": "<string>",
  "isInStock": true,
  "isDiscontinued": true,
  "priceRange": {
    "minVariantPrice": 123,
    "maxVariantPrice": 123
  },
  "retailPriceRange": {
    "minVariantPrice": 123,
    "maxVariantPrice": 123
  },
  "priceDeltaByCountry": {
    "US": 2.5,
    "CA": 3.5
  },
  "options": [
    {
      "name": "size",
      "values": [
        {
          "title": "<string>",
          "colorCode": "<string>",
          "colorCode2": "<string>"
        }
      ]
    }
  ],
  "isPersonalized": true,
  "creationStatus": "Pending",
  "sizeChartImages": [
    {
      "url": "<string>",
      "width": 123,
      "height": 123
    }
  ],
  "featuredImage": {
    "url": "<string>",
    "lowResUrl": "<string>",
    "width": 123,
    "height": 123
  },
  "tags": [
    {
      "name": "<string>"
    }
  ],
  "variants": [
    {
      "id": "<string>",
      "title": "<string>",
      "price": 123,
      "retailPrice": 123,
      "isAvailableForSale": true,
      "options": [
        {
          "name": "size",
          "value": {
            "title": "<string>",
            "colorCode": "<string>",
            "colorCode2": "<string>"
          }
        }
      ],
      "images": [
        {
          "url": "<string>",
          "lowResUrl": "<string>",
          "width": 123,
          "height": 123
        }
      ]
    }
  ],
  "errors": {
    "hasLowResolutionElements": true,
    "hasNonCmykElements": true,
    "hasBaseProductIssue": true,
    "hasNonBlackAndWhiteElements": true,
    "isBlank": true,
    "hasOldPrintAreas": true
  },
  "customFields": {},
  "shippingRegions": [
    {
      "countryName": "<string>",
      "countryCode": "<string>",
      "isBlacklisted": true,
      "provinces": [
        {
          "provinceName": "<string>",
          "provinceCode": "<string>"
        }
      ]
    }
  ]
}

International pricing

NOTE! Some products have a priceDeltaByCountry field that will affect the price of the product when shipped internationally. If you pass countryCode when getting the product you will get the price after applying the delta. If you don’t pass countryCode you should apply the delta yourself based on the recipient’s address

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