PATCH
Partial update of a 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
title
string
sku
string
price
integer

Cents.

Required range: x >= 0
image_url
string<uri>
compare_at_price
integer

Cents; strikethrough price.

Required range: x >= 0
inventory_quantity
integer
Required range: x >= 0

Response

OK

success
boolean
required
message
string
data
object
meta
object