List Product Variants

GET

vendor

products

{id}

variants

curl 'http://localhost:9000/vendor/products/prod_01HXYZ/variants?limit=20' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

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

{
  "variants": [
    {
      "id": "variant_01HXYZ",
      "title": "M",
      "sku": "ACME-SHIRT-M",
      "product_id": "prod_01HXYZ",
      "manage_inventory": false,
      "allow_backorder": false
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

Returns the variants belonging to the given product.

Path parameters

string

required

The product’s ID.

Query parameters

number

default:"50"

The maximum number of variants to return.

number

default:"0"

The number of variants to skip before returning results.

string

The field to sort by, e.g. variant_rank or -created_at.

string

Comma-separated fields to include in the response. Prefix with +/- to add to or remove from the defaults.

string

Search term matched against variant fields.

boolean

Filter by whether inventory is managed for the variant.

boolean

Filter by whether backorders are allowed.

object

Filter by creation date using operators like $gt, $lt, $gte, $lte.

object

Filter by update date using operators like $gt, $lt, $gte, $lte.

object[]

Join multiple filter objects with a logical AND.

object[]

Join multiple filter objects with a logical OR.

Response

object[]

Show properties

string

The variant’s ID.

string

The variant’s title.

string

The variant’s SKU.

string

ID of the parent product.

boolean

Whether inventory is managed for the variant.

boolean

Whether backorders are allowed.

number

Sort rank of the variant.

object[]

Selected option values with id, value, and the parent option.

object[]

Variant images with id, url, and rank.

number

Total number of matching variants.

number

Number of skipped variants.

number

Maximum number of returned variants.

curl 'http://localhost:9000/vendor/products/prod_01HXYZ/variants?limit=20' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

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

{
  "variants": [
    {
      "id": "variant_01HXYZ",
      "title": "M",
      "sku": "ACME-SHIRT-M",
      "product_id": "prod_01HXYZ",
      "manage_inventory": false,
      "allow_backorder": false
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

curl 'http://localhost:9000/vendor/products/prod_01HXYZ/variants?limit=20' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

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

{
  "variants": [
    {
      "id": "variant_01HXYZ",
      "title": "M",
      "sku": "ACME-SHIRT-M",
      "product_id": "prod_01HXYZ",
      "manage_inventory": false,
      "allow_backorder": false
    }
  ],
  "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