Update Product Variant

POST

vendor

products

{id}

variants

{variant_id}

curl -X POST 'http://localhost:9000/vendor/products/prod_01HXYZ/variants/variant_01HXYZ' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>' \
  -H 'Content-Type: application/json' \
  -d '{"sku": "ACME-SHIRT-M-V2", "weight": 200}'

const { product_change } =
  await client.vendor.products.$id.variants.$variant_id.mutate({
    $id: "prod_01HXYZ",
    $variant_id: "variant_01HXYZ",
    sku: "ACME-SHIRT-M-V2",
    weight: 200,
  })

{
  "product_change": {
    "id": "prodch_01HXYZ",
    "product_id": "prod_01HXYZ",
    "status": "pending",
    "actions": [
      {
        "id": "prodchact_01HXYZ",
        "action": "VARIANT_UPDATE",
        "details": { "variant_id": "variant_01HXYZ", "fields": { "sku": "ACME-SHIRT-M-V2" } },
        "applied": false
      }
    ]
  }
}

Stages a VARIANT_UPDATE operation as a pending change request instead of updating the variant directly.

The endpoint responds with 202 Accepted and a product_change record, not the updated variant.

Path parameters

string

required

The product’s ID.

string

required

The variant’s ID.

Body parameters

string

The variant’s title.

string

The variant’s SKU.

string

EAN barcode.

string

UPC barcode.

string

ISBN code.

string

Amazon ASIN.

string

GTIN code.

string

Generic barcode.

string

Harmonized System code.

string

Manufacturer ID code.

string

Variant thumbnail URL.

number

Sort rank of the variant.

number

Weight of the variant.

number

Length of the variant.

number

Height of the variant.

number

Width of the variant.

string

Country of origin.

string

Material of the variant.

boolean

Whether backorders are allowed.

boolean

Whether inventory is managed for the variant.

object

Custom key-value pairs.

object

Option title to value mapping, e.g. {"Size": "M"}.

object

Show properties

string[]

Image URLs to attach to the variant.

string[]

Image IDs to detach from the variant.

Response

object

Show properties

string

The change request’s ID.

string

ID of the product the change targets.

string

One of pending, confirmed, declined, canceled.

object[]

Staged operations, each with id, action (VARIANT_UPDATE), details, ordering, and applied.

curl -X POST 'http://localhost:9000/vendor/products/prod_01HXYZ/variants/variant_01HXYZ' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>' \
  -H 'Content-Type: application/json' \
  -d '{"sku": "ACME-SHIRT-M-V2", "weight": 200}'

const { product_change } =
  await client.vendor.products.$id.variants.$variant_id.mutate({
    $id: "prod_01HXYZ",
    $variant_id: "variant_01HXYZ",
    sku: "ACME-SHIRT-M-V2",
    weight: 200,
  })

{
  "product_change": {
    "id": "prodch_01HXYZ",
    "product_id": "prod_01HXYZ",
    "status": "pending",
    "actions": [
      {
        "id": "prodchact_01HXYZ",
        "action": "VARIANT_UPDATE",
        "details": { "variant_id": "variant_01HXYZ", "fields": { "sku": "ACME-SHIRT-M-V2" } },
        "applied": false
      }
    ]
  }
}

curl -X POST 'http://localhost:9000/vendor/products/prod_01HXYZ/variants/variant_01HXYZ' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>' \
  -H 'Content-Type: application/json' \
  -d '{"sku": "ACME-SHIRT-M-V2", "weight": 200}'

const { product_change } =
  await client.vendor.products.$id.variants.$variant_id.mutate({
    $id: "prod_01HXYZ",
    $variant_id: "variant_01HXYZ",
    sku: "ACME-SHIRT-M-V2",
    weight: 200,
  })

{
  "product_change": {
    "id": "prodch_01HXYZ",
    "product_id": "prod_01HXYZ",
    "status": "pending",
    "actions": [
      {
        "id": "prodchact_01HXYZ",
        "action": "VARIANT_UPDATE",
        "details": { "variant_id": "variant_01HXYZ", "fields": { "sku": "ACME-SHIRT-M-V2" } },
        "applied": false
      }
    ]
  }
}

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