Skip to main content
PATCH
/
v1
/
variants
/
{id}
Update
curl --request PATCH \
  --url https://{defaultHost}/v1/variants/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "variant": {
    "sku": "abc-123-xyz"
  }
}
'
{
  "id": "8f7ad2c5-b208-45c9-bdcb-9d298a6a9645",
  "object": "variant",
  "amount": null,
  "available_stock": 0,
  "allow_out_of_stock_purchases": null,
  "auto_fulfill_enabled": null,
  "currency": "usd",
  "current_version": true,
  "g_weight": null,
  "held_stock": 0,
  "license_activation_limit": null,
  "metadata": {},
  "option_1": "Blue",
  "option_2": null,
  "option_3": null,
  "option_names": [
    "Color"
  ],
  "position": 0,
  "purchase_limit": null,
  "shipping_enabled": null,
  "sku": "abc-123-xyz",
  "stock": 0,
  "stock_enabled": null,
  "tax_category": null,
  "tax_enabled": null,
  "weight_unit": null,
  "weight": null,
  "image": null,
  "product": "04a168ab-9328-4c7b-bfdf-1b2edc6fbb70",
  "created_at": 1767909788,
  "updated_at": 1767909788
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
variant
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
amount
integer | null

The amount in cents to be charged, represented as a whole integer for this specific integer. If empty, the regular Price amount will be used. If the Product has multiple prices, then this amount will be ignored and the selected Price amount will be used.

​
allow_out_of_stock_purchases
boolean | null

Whether or not to allow purchases of this variant when stock runs out. If true, the stock levels for this variant can go below zero. If null, inherits from the product.

​
auto_fulfill_enabled
boolean | null

Whether or not this variant should be auto fulfilled when it is purchased. This can only be true when shipping_enabled is false. If null, inherits from the product.

​
license_activation_limit
integer | null

The max number of activations allowed per license. If null, inherits from the product or price.

​
option_1
string

The value for the first variant option.

​
option_2
string | null

The value for the second variant option.

​
option_3
string | null

The value for the third variant option.

​
position
integer | null

The ordering position of this variant when displayed to customers.

​
purchase_limit
integer | null

The max number of times this variant can be purchased by a customer. If null, inherits from the product.

​
shipping_enabled
boolean | null

If set to true checkouts with this variant will require a full shipping address. If null, inherits from the product.

​
sku
string | null

The stock keeping unit for this variant.

​
stock_enabled
boolean | null

Whether or not stock will be tracked for this variant. If null, inherits from the product.

​
tax_category
string | null

The tax category/code that matches this variant. If null, inherits from the product.

​
tax_enabled
boolean | null

If set to true, this variant is considered taxable. If null, inherits from the product.

​
weight
number | null

The variant weight, meant to be displayable to the customer. If null, inherits from the product.

​
weight_unit
string | null

The weight unit for this variant. If null, inherits from the product.

​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

​
available_stock
integer

The total amount of stock available for purchase. This is the total stock on hand minus held_stock.

​
currency
string

Three-letter ISO currency code, in lowercase. This is inherited from the price.

​
current_version
boolean

Whether or not this object represents the current version of this variant. (This will be false if the association was created to this variant before it was altered. In this case, we will lookup the version of the variant at the time it was associated.)

​
g_weight
number | null

The weight of this variant in grams. If null, inherits from the product.

​
held_stock
integer

The total amount of stock being held by unfulfilled line items.

​
image

Expandable – The associated media ID.

​
option_names
array

An array of the associated product's variant option names.

​
product

Expandable – The associated product ID.

​
stock
integer

The total amount of stock on hand for this product.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.