Skip to main content
PATCH
Update a variant

Authorizations

x-api-key
string
header
required

Your Store API key (pk_live_...). Create it in Developers › API keys.

x-store-hash
string
header
required

The ID of the store the request is for. Shown in Developers › API keys.

Path Parameters

id
string
required

Product hash ID (numeric ID also accepted).

Example:

"AbC123xyz789"

variantId
string
required

Variant ID.

Example:

"881"

Body

application/json
name
string
slug
string
delivery_type
enum<string>

Digital products only.

Available options:
file,
license
price_cents
integer
discount_percent
number
stock_quantity
integer | null

null = unlimited. Not for license variants.

is_default
boolean
active
boolean
sort_order
integer
image_url
string
sku
string

Physical only.

barcode
string
weight_grams
integer
compare_at_cents
integer
track_inventory
boolean
allow_backorder
boolean
low_stock_threshold
integer
option_values
string[]

Physical only. Must match the product's options.

Response

Updated

success
boolean
required
Example:

true

variant
object