Inventory

Adjust inventory

Increases or decreases a physical product's quantity by a delta, with a reason shown in the merchant's log.

POST/stores/{storeId}/v1/products/{id}/inventory-adjustments

Scopeinventory:writeAdjust physical inventory

delta is a non-zero integer up to 100,000, and reason is 3 to 240 characters. No If-Match: the delta is applied to the current quantity, whatever it is.

Path parameters

idstringrequired

Headers

Idempotency-Keystringrequired

Request body

deltaintegerrequired
reasonstringrequired

Response

dataobjectrequired
product_idinteger
quantityinteger
beforeinteger
deltainteger
resource_versioninteger
executionobject: Who executed the request: the app, version, installation and store. Field names here are camelCase.
appIdstring (uuid)
versionIdstring (uuid)
installationIdstring (uuid)
storeIdstring (uuid)
requestIdstring (uuid)
generationinteger
routeEpochinteger
appAuthEpochinteger
grantRevisioninteger
metaobjectrequired
request_idstring (uuid): The request ID; include it in any support request.

Errors

HTTP	Code	Meaning
409	`INSUFFICIENT_STOCK`	The quantity is not enough for the decrease.
422	`PHYSICAL_MANUAL_STOCK_REQUIRED`	The product does not use manual stock.

Shared codes are listed in Errors.

curl -X POST "https://larm.sa/stores/$STORE_ID/v1/products/57/inventory-adjustments" \ -H "Authorization: Bearer $ACCESS_TOKEN" \ -H "Idempotency-Key: $UUID" \ -H "Content-Type: application/json" \ -d '{ "delta": -2, "reason": "In-store sale" }'

{ "data": { "product_id": 57, "quantity": 12, "before": 14, "delta": -2, "resource_version": 13 }, "execution": { "appId": "1f2e3d4c-5b6a-4978-8695-a4b3c2d1e0f9", "versionId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "installationId": "c7e4a1f2-6b3d-4e8a-9c05-1d2f3a4b5c6d", "storeId": "5b1d7a62-0c4e-4f38-9a51-2e7b3c9d8f10", "requestId": "3f0c2b8e-7a51-4c1e-9d0a-5b6f1e2d4c3a", "generation": 1, "routeEpoch": 4, "appAuthEpoch": 1, "grantRevision": 2 }, "meta": { "request_id": "3f0c2b8e-7a51-4c1e-9d0a-5b6f1e2d4c3a" } }