Update Product Variant

POST

admin

products

{id}

variants

{variant_id}

curl -X POST 'http://localhost:9000/admin/products/prod_01HXYZABCDEF/variants/variant_01HXYZABCDEF' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"sku": "LS-M-2026"}'

const { product } = await client.admin.products.$id.variants.$variant_id.mutate({
  $id: "prod_01HXYZABCDEF",
  $variant_id: "variant_01HXYZABCDEF",
  sku: "LS-M-2026",
})

{
  "product": {
    "id": "prod_01HXYZABCDEF",
    "title": "Linen Shirt",
    "variants": [
      { "id": "variant_01HXYZABCDEF", "title": "M", "sku": "LS-M-2026" }
    ]
  }
}

Updates the variant and returns the parent product.

Path parameters

string

required

The product’s ID.

string

required

The variant’s ID.

Body parameters

string

Variant title.

string

Variant SKU.

string

Variant EAN.

string

Variant UPC.

string

Variant ISBN.

string

Variant ASIN.

string

Variant GTIN.

string

Variant barcode.

string

Harmonized System code.

string

Manufacturer identification code.

string

URL of the variant thumbnail.

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.

object[]

Variant prices.

Show properties

string

Existing price ID to update.

string

Price currency code.

number

Price amount.

number

Minimum quantity for the price to apply.

number

Maximum quantity for the price to apply.

object

Map of rule attribute to value.

object

Map of option title to option value.

object

Custom key-value data.

object

Custom data passed to workflow hooks.

Response

object

Show properties

string

The product’s ID.

string

Product title.

object[]

All variants, including the updated one.

string

Last update timestamp.

curl -X POST 'http://localhost:9000/admin/products/prod_01HXYZABCDEF/variants/variant_01HXYZABCDEF' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"sku": "LS-M-2026"}'

const { product } = await client.admin.products.$id.variants.$variant_id.mutate({
  $id: "prod_01HXYZABCDEF",
  $variant_id: "variant_01HXYZABCDEF",
  sku: "LS-M-2026",
})

{
  "product": {
    "id": "prod_01HXYZABCDEF",
    "title": "Linen Shirt",
    "variants": [
      { "id": "variant_01HXYZABCDEF", "title": "M", "sku": "LS-M-2026" }
    ]
  }
}

curl -X POST 'http://localhost:9000/admin/products/prod_01HXYZABCDEF/variants/variant_01HXYZABCDEF' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"sku": "LS-M-2026"}'

const { product } = await client.admin.products.$id.variants.$variant_id.mutate({
  $id: "prod_01HXYZABCDEF",
  $variant_id: "variant_01HXYZABCDEF",
  sku: "LS-M-2026",
})

{
  "product": {
    "id": "prod_01HXYZABCDEF",
    "title": "Linen Shirt",
    "variants": [
      { "id": "variant_01HXYZABCDEF", "title": "M", "sku": "LS-M-2026" }
    ]
  }
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Path parameters

Body parameters

Response

​Path parameters

​Body parameters

​Response

Path parameters

Body parameters

Response