Docs
Catalog API
Product variants
Variants Batch

Variants (Batch)

Get all variants

GET /catalog/variants

Request

Returns a list of all variants in your catalog. Optional parameters can be passed in.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • id in query - integer

    Filter items by variant ID.

example

Response

Body

object | application/json

  • data    array[object]

  • meta    object

    Data about the response, including pagination and collection totals.

example

Update Variants (Batch)

PUT /catalog/variants

Request

Updates a batch of variant objects. Currently the limit is 50 variants however this is subject to change.

Required Fields

To update an existing variant:

  • id (variant ID)

To create a new variant:

  • product_id
  • sku
  • option_values
    • id (option_value ID - Example: 146)
    • option_id (Option ID - Example: 151)

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

Body

array | application/json

example

Response

Body

object | application/json

  • data    array[object]

  • meta    object

    Data about the response, including pagination and collection totals.

example

Did you find what you were looking for?
Delete a Product Variant MetafieldGet all variants