PATCH
Update a product

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key
string
required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Path Parameters

productId
string
required

Body

application/json

Every value is an absolute target, so replaying converges. A field sent as null CLEARS the column where the type allows null; a field omitted is left alone. Options, variants and images are separate resources with their own routes, and an array here is refused.

title
string
handle
string

Required on create, unlike the dashboard. Without it a retry outside the idempotency window mints a SECOND product at a suffixed handle; with it the retry collides and returns 409 handle_taken.

subtitle
string | null
description
string | null
thumbnail
string | null
meta_title
string | null
meta_description
string | null
attributes
object

Merchant-defined JSON, stored unchanged and unvalidated.

discountable
boolean

Defaults to true when omitted.

unpublish_at
string<date-time> | null
material
string | null
weight
string | null

A decimal string, not a number, matching the column and the read shape.

length
string | null
height
string | null
width
string | null
hs_code
string | null
mid_code
string | null
origin_country
string | null

Response

Success

data
object