List Product Variants

GET

admin

products

{id}

variants

curl 'http://localhost:9000/admin/products/prod_01HXYZABCDEF/variants?limit=20' \
  -H 'Authorization: Bearer <token>'

const { variants, count } = await client.admin.products.$id.variants.query({
  $id: "prod_01HXYZABCDEF",
  limit: 20,
})

{
  "variants": [
    {
      "id": "variant_01HXYZABCDEF",
      "title": "M",
      "sku": "LS-M",
      "product_id": "prod_01HXYZABCDEF",
      "manage_inventory": false,
      "allow_backorder": false,
      "variant_rank": 0
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

Returns the variants of a single product, with optional filtering by SKU and identifiers.

Path parameters

string

required

The product’s ID.

Query parameters

number

default:"50"

Maximum number of records to return.

number

default:"0"

Number of records to skip.

string

Field to sort by, prefix with - for descending order.

string

Comma-separated list of fields to include, prefix with +/- to add or remove from defaults.

string

Search term matched against variant fields.

string | string[]

Filter by variant ID(s).

string

Filter by SKU.

string

Filter by EAN.

string

Filter by UPC.

string

Filter by barcode.

Response

object[]

Show properties

string

The variant’s ID.

string

Variant title.

string

Variant SKU.

string

Variant EAN.

string

Variant UPC.

string

Variant barcode.

string

Harmonized System code.

string

Manufacturer identification code.

number

Sort rank of the variant.

number

Variant weight.

number

Variant length.

number

Variant height.

number

Variant width.

string

Country of origin.

string

Variant material.

string

ID of the parent product.

boolean

Whether inventory is tracked for the variant.

boolean

Whether the variant can be ordered when out of stock.

object[]

The variant’s option values.

object

Custom key-value data.

string

Creation timestamp.

string

Last update timestamp.

number

Total number of matching variants.

number

Number of records skipped.

number

Number of records returned.

curl 'http://localhost:9000/admin/products/prod_01HXYZABCDEF/variants?limit=20' \
  -H 'Authorization: Bearer <token>'

const { variants, count } = await client.admin.products.$id.variants.query({
  $id: "prod_01HXYZABCDEF",
  limit: 20,
})

{
  "variants": [
    {
      "id": "variant_01HXYZABCDEF",
      "title": "M",
      "sku": "LS-M",
      "product_id": "prod_01HXYZABCDEF",
      "manage_inventory": false,
      "allow_backorder": false,
      "variant_rank": 0
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

curl 'http://localhost:9000/admin/products/prod_01HXYZABCDEF/variants?limit=20' \
  -H 'Authorization: Bearer <token>'

const { variants, count } = await client.admin.products.$id.variants.query({
  $id: "prod_01HXYZABCDEF",
  limit: 20,
})

{
  "variants": [
    {
      "id": "variant_01HXYZABCDEF",
      "title": "M",
      "sku": "LS-M",
      "product_id": "prod_01HXYZABCDEF",
      "manage_inventory": false,
      "allow_backorder": false,
      "variant_rank": 0
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Path parameters

Query parameters

Response

​Path parameters

​Query parameters

​Response

Path parameters

Query parameters

Response