Catalog variant

{
  "source_variant_id": "<string>",
  "option_values": {},
  "title": "<string>",
  "sku": "<string>",
  "canonical_url": "<string>",
  "available": true,
  "inventory_quantity": 123,
  "inventory_observed_at": "2023-11-07T05:31:56Z",
  "inventory_policy": "<string>",
  "inventory_item_id": "<string>",
  "image_url": "<string>",
  "media": [
    {
      "external_media_id": "<string>",
      "url": "<string>",
      "role": "<string>",
      "position": 0
    }
  ]
}

Option 1
Option 2

source_variant_id

string

required

Stable source ID. Required unless option_values uniquely identifies the variant.

Maximum string length: 255

option_values

object

Show child attributes

title

string

Maximum string length: 255

sku

string

Maximum string length: 255

canonical_url

string<uri>

Public URL that opens this exact variant.

Maximum string length: 8192

available

boolean | null

Whether this exact variant can currently be purchased. Omit or use null when inventory is unknown.

inventory_quantity

integer | null

Exact source-reported count when known. Send available separately; quantity alone does not set availability.

inventory_observed_at

string<date-time> | null

Source observation time. Older observations do not replace newer stock for the same variant; the request time is used when omitted.

inventory_policy

string

Source inventory policy, preserved without normalization.

Maximum string length: 255

inventory_item_id

string

Maximum string length: 255

price

object

Show child attributes

compare_at_price

object

Show child attributes

image_url

string<uri>

Maximum string length: 8192

media

object[]

Maximum array length: 100

Show child attributes

Get started

Shopify

Custom JavaScript

Recommendations

Operate

API reference