Variant

Variants describe configurations a shopper can pick on a product — size, color, storage tier, etc.

Variant support is rolling out. It is not yet live on all products.

Shape

product.variants is either null (no variations) or:

{
  "options": [
    {
      "name": "Color",
      "values": [
        { "label": "Black", "exists": true, "available": "InStock" },
        { "label": "Navy", "exists": true, "available": "OutOfStock" }
      ]
    },
    {
      "name": "Size",
      "values": [
        { "label": "M", "exists": true },
        { "label": "L", "exists": true }
      ]
    }
  ],
  "selected": [
    { "name": "Color", "label": "Black" },
    { "name": "Size", "label": "M" }
  ]
}

Full guide

For rendering selectors, exists vs available, and fetching a specific configuration, see the Variants guide.

Getting Started

Make a Search

Get Product Data

Pricing + Commissions

Build

Integrate

FAQ

Shape

Full guide

​Shape

​Full guide

Shape

Full guide