List Variants

GET

vendor

product-variants

curl 'http://localhost:9000/vendor/product-variants?sku=ACME-SHIRT-M' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { variants, count } = await client.vendor.productVariants.query({
  sku: "ACME-SHIRT-M",
})

{
  "variants": [
    {
      "id": "variant_01HXYZ",
      "title": "M",
      "sku": "ACME-SHIRT-M",
      "product_id": "prod_01HXYZ",
      "product": { "id": "prod_01HXYZ", "title": "Acme T-Shirt" }
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 50
}

Returns product variants regardless of parent product, with the parent product embedded.

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. created_at or -created_at for descending.

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.

string | string[]

Filter by variant ID(s).

boolean

Filter by whether inventory is managed for the variant.

boolean

Filter by whether backorders are allowed.

string | string[]

Filter by SKU(s).

string | string[]

Filter by EAN(s).

string | string[]

Filter by UPC(s).

string | string[]

Filter by barcode(s).

string | string[]

Filter by parent product ID(s).

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

Filter by deletion 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

EAN barcode.

string

UPC barcode.

string

Generic barcode.

string

ID of the parent product.

object

The parent product record.

boolean

Whether inventory is managed for the variant.

boolean

Whether backorders are allowed.

number

Sort rank of the variant.

number

Total number of matching variants.

number

Number of skipped variants.

number

Maximum number of returned variants.

curl 'http://localhost:9000/vendor/product-variants?sku=ACME-SHIRT-M' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { variants, count } = await client.vendor.productVariants.query({
  sku: "ACME-SHIRT-M",
})

{
  "variants": [
    {
      "id": "variant_01HXYZ",
      "title": "M",
      "sku": "ACME-SHIRT-M",
      "product_id": "prod_01HXYZ",
      "product": { "id": "prod_01HXYZ", "title": "Acme T-Shirt" }
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 50
}

curl 'http://localhost:9000/vendor/product-variants?sku=ACME-SHIRT-M' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { variants, count } = await client.vendor.productVariants.query({
  sku: "ACME-SHIRT-M",
})

{
  "variants": [
    {
      "id": "variant_01HXYZ",
      "title": "M",
      "sku": "ACME-SHIRT-M",
      "product_id": "prod_01HXYZ",
      "product": { "id": "prod_01HXYZ", "title": "Acme T-Shirt" }
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 50
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Query parameters

Response

​Query parameters

​Response

Query parameters

Response