Product Catalog

Overview

The Product Catalog API provides a complete view of all available products in the catalog in a single response. This includes catalog information such as available variants with SKUs, decoration areas with their sizes, templates for each variant, and the required file types.

This endpoint is typically used to:

Retrieve product information and decoration details for correct artwork placement ( Size, DPI, File Type, Templates )

But it can also be used to:

Sync a merchant's catalog with an e-commerce platform

Display available products and variants in a storefront

To get the list of products, please send a GET request to the following URL:

The size of the response can also be limited through the use of pagination, by specifying page and pageSize parameters.

Sample Request

Sample Response

{
  "variants": [
    {
      "sku": "Accent_Mug-11oz-Blue",
      "merchantPrice": {
        "currencies": [],
        "amount": 0,
        "currency": "USD"
      },
      "decorations": [
        {
          "area": "Default",
          "width": 2475,
          "height": 1050,
          "dpi": 300,
          "method": "DTG",
          "price": {
            "currencies": [],
            "amount": 0,
            "currency": "USD"
          }
        }
      ],
      "attributes": [
        {
          "name": "TemplateURL",
          "value": "https://drive.google.com/file/d/195msT9bpefiFCZYYSZaJUbW4dcDYuBlH/view"
        },
        {
          "name": "FileType",
          "value": "pdf"
        }
      ]
    },
    // ... more variants
  ],
  "totalVariants": 13
}

Response Breakdown

The response contains a structured JSON with all available product variants. Let's break down the key parts of the response:

Top-Level Fields

variants – An array of product variants, each representing a specific variant of the product, such as different sizes or colors.

totalVariants – The total number of variants included in the Catalog.

Variant Object

Each item in the variants array represents a single product variant. Here's what each field means:

sku – The unique identifier for the product variant.

Typically encodes product name, and sometimes additional attributes like size and color.

This is the identifier you should use to place orders into the system.

merchantPrice – Pricing information for this variant. This is an optional value that doesn't affect order processing and will be 0 for most use cases.

amount – The base price charged to the merchant.

currency – The currency of the price.

currencies – Reserved for multi-currency support.

decorations – Defines printable areas and methods available for this variant. Each decoration includes:

area – Name of the printable area. This is the name you should input on the order payload to identify where the image will be placed. For items with only one print area, use "Default".

width/height – Dimensions of the print area in pixels. The image provided for the product/area should have these dimensions.

dpi – The resolution requirement for the artwork.

method – The available printing techniques for the product include options such as DTG, DTF, and Embroidery.

This data point is optional and is primarily relevant for apparel products.

If a printing technique is not specified in the catalog, it indicates that the product only offers one printing method. In that case, remove the printMethod data point from the order creation payload.

price – Any additional cost for the decoration. This is an optional value that doesn't affect order processing and will be 0 for most use cases.

attributes – Additional information about the product variant. Includes:

TemplateURL – A link to a downloadable print template. Designers can use this to ensure artwork fits the printable area.

FileType – The mandatory file format for artwork.

Overview#

Sample Request#

Sample Response#

Response Breakdown#