PATCH
Partial update. Omitted fields are left untouched.

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

product_id
string
required

Body

application/json
title
string
handle
string
product_type
string
vendor
string
price
integer

Cents.

Required range: x >= 0
status
enum<integer>
Available options:
0,
1,
2
tags
string[]
options
string[]
supplier_id
string

Default 3PL/supplier. "" unassigns; omit to leave unchanged.

pdp_template_id
string

Product-page template. "" falls back to the default; omit to leave unchanged.

fulfillment_rules
object[]

Destination-based routing, resolved at order finalize. First matching rule wins.

description
string

Accepted and ignored — stored in a separate table.

category
string

Accepted and ignored — stored in a separate table.

Response

OK

success
boolean
required
message
string
data
object

The list endpoint leaves description and category empty and omits variants; fetch a single product for the fully enriched object.

meta
object