PATCH
Update one variant.

Authorizations

X-Agent-Key
string
header
required

Service-account key, format sq_agt_*. Carries least-privilege scopes.

Headers

Idempotency-Key
string

Optional on the products domain API — absent, the request simply executes. When present, a replay with the same body returns the cached response and a different body returns 409. Send it on every write anyway.

Maximum string length: 200
X-Store-ID
string

Target store; required when the key is bound to multiple stores.

Path Parameters

variant_id
string
required

Body

application/json

Send only the fields to change.

price

Amount in major units as a decimal string (preferred) or a number. At most two decimals; negative values are rejected (422).

Example:

"19.99"

compare_at_price

Must be higher than price. null ends a sale.

Example:

"19.99"

sku
string
title
string
inventory_quantity
integer
Required range: x >= 0
inventory_tracked
boolean
inventory_policy
enum<string>
Available options:
continue,
deny

Response

OK

success
boolean
required
message
string
data
object
meta
object