Skip to main content
GET
/
v1
/
variants
List
curl --request GET \
  --url https://{defaultHost}/v1/variants \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/variants"
  },
  "data": [
    {
      "id": "2003f334-71b1-44b1-9ee0-c911116d2980",
      "object": "variant",
      "amount": null,
      "available_stock": 0,
      "allow_out_of_stock_purchases": null,
      "auto_fulfill_enabled": null,
      "currency": "usd",
      "current_version": true,
      "g_weight": null,
      "held_stock": 0,
      "license_activation_limit": null,
      "metadata": {},
      "option_1": "Blue",
      "option_2": null,
      "option_3": null,
      "option_names": [
        "Color"
      ],
      "position": 0,
      "purchase_limit": null,
      "shipping_enabled": null,
      "sku": null,
      "stock": 0,
      "stock_enabled": null,
      "tax_category": null,
      "tax_enabled": null,
      "weight_unit": null,
      "weight": null,
      "image": null,
      "product": "35751772-31b9-4e9e-8fee-1b9da6060eca",
      "created_at": 1767909787,
      "updated_at": 1767909787
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

ids[]
string[]

Only return objects with the given IDs.

limit
integer

A limit on the number of items to be returned, between 1 and 100.

page
integer

The page of items you want returned.

product_ids[]
string[]

Only return objects that belong to the given products.

Response

200 - application/json

Success

object
string

A string describing the object type returned.

pagination
object
data
array

An array of objects.