Skip to main content
POST
Adjust physical stock

Authorizations

x-api-key
string
header
required

Your Store API key (pk_live_...). Create it in Developers › API keys.

x-store-hash
string
header
required

The ID of the store the request is for. Shown in Developers › API keys.

Headers

Idempotency-Key
string

Unique key (for example a UUID) that makes retries safe. The first response is stored for 24 hours and replayed for retries with the same key and body.

Maximum string length: 255

Path Parameters

id
string
required

Product hash ID (numeric ID also accepted).

Example:

"AbC123xyz789"

Body

application/json
variant_id
integer
required
delta
integer

Exactly one of delta or set.

set
integer
Required range: x >= 0
reason
string

Response

Adjusted

success
boolean
required
Example:

true

movement
object
variant
object