Inventory

Adjust stock

POST
/api/v1/inventory/items/{item_id}/adjust

Move stock by hand. Every adjustment is a ledger row with a named actor.

Authorization

HTTPBearer
AuthorizationBearer <token>

JWT access token

In: header

Path Parameters

item_id*string
Formatuuid

Query Parameters

merchant_id?|

Optional merchant to act on. Must be one you are a member of.

Formatuuid

Header Parameters

X-Merchant-ID?string|null

Request Body

application/json

movement_type?string
Lengthlength <= 32
Default"ADJUSTMENT"
note?string
Lengthlength <= 500
Default""
quantity*number
Range0 <= value
reference_id?string
Lengthlength <= 64
Default""
reference_type?string
Lengthlength <= 32
Default""

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/inventory/items/497f6eca-6276-4993-bfeb-53cbbbba6f08/adjust" \  -H "Content-Type: application/json" \  -d '{    "quantity": 0  }'
{  "data": {},  "meta": {},  "success": true}