PATCH
Set draft / active / archived on many products.

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.

Body

application/json
product_ids
string[]
required
Minimum array length: 1
status
enum<integer>
required
Available options:
0,
1,
2

Response

Number of rows the bulk operation actually changed.

success
boolean
required
message
string
data
object
meta
object