PUT
Update a product.

Authorizations

X-Agent-Key
string
header
required

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

Headers

Idempotency-Key
string
required

Unique per logical operation; identical key+body returns the cached response, different body → 409.

Maximum string length: 200
X-Store-ID
string

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

Path Parameters

product_id
string
required

Body

application/json
title
string
handle
string
product_type
string
vendor
string
tags
string[]
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"

status
enum<string>

Case-insensitive.

Available options:
DRAFT,
ACTIVE,
ARCHIVED
description
string
category
string

Response

OK

success
boolean
required
message
string
data
object
meta
object