Create Stock Adjustment

Adjusts the on-hand quantity of a stock record up or down (unit_quantity is a signed delta) with a typed reason. Serialized variants take serials instead of a free quantity; batch products take batches. adjustment_type must be one of the company's configured stock-adjustment types (GET /ui/types/stock-adjustment). Requires the Create Stock Adjustment permission on the stock's location. Back-dating via date requires the company backdate setting and is limited to 30 days.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Stock id

Body Params

Adjustment payload

number

Signed quantity delta in unit (required); negative reduces stock

string

Unit of the delta (required)

string

Key of a configured stock-adjustment type, e.g. loss, expire, recount (required)

string
length ≤ 1024

Free-text reason (required)

serials
array of strings

Serial numbers to adjust (serialized variants); the sign of unit_quantity decides add/remove

serials
batches
array of objects
batches
string | null

Back-date the adjustment, Y-m-d H:i:s in store timezone

Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json