Get adjustments
List stock adjustments for your company, oldest first (by creation time), with optional filters.
A stock adjustment is a manual change to on-hand inventory that isn't a sale, purchase, or transfer — for example recording waste, theft, damage, a physical recount, or a reconciliation with the state compliance system.
Narrow the result with the product_ids, batch_ids, and location_ids filters (matching each adjustment's product_id / batch_id / location_id) and with the inserted_datetime, completion_datetime, and updated_datetime windows. When several filters are supplied an adjustment must satisfy all of them (AND).
Results are always scoped to the company the API key belongs to. The response is a paginated envelope: data holds the page of adjustments and next_page is the URL of the following page, or null on the last page.
This endpoint returns eventually consistent data, with changes taking up to 1 second to propagate in responses.
Required permission: products_permissions_view.
Query parameters
Restrict the result to specific stock adjustments by ID (the same ID returned as each stock adjustment's id). Repeat the bracketed key once per ID. Unknown IDs simply match nothing; an empty list is treated as no filter. At most 200 IDs may be given.
Filter by when the adjustment was created in Distru (its inserted_datetime). Inclusive ISO8601 range after,before separated by a comma; either bound may be omitted — after, keeps adjustments created on or after after, ,before those on or before before, and after,before those inside the closed range. A range with both bounds empty is rejected.
Filter by the adjustment's effective date — the completion_datetime in the response. Inclusive ISO8601 range after,before separated by a comma; either bound may be omitted. A range with both bounds empty is rejected.
Filter by when the adjustment was last modified in Distru (its updated_datetime). Same inclusive ISO8601 after,before comma range format as inserted_datetime, with either bound optional.
Restrict to adjustments made against specific batches by batch ID (as returned in each adjustment's batch_id). Repeat the bracketed key once per ID; matches ANY. Unknown IDs match nothing; an empty list is no filter. At most 200 IDs.
Restrict to adjustments made at specific locations by location ID (as returned in each adjustment's location_id). Repeat the bracketed key once per ID; matches ANY. Unknown IDs match nothing; an empty list is no filter. At most 200 IDs.
Restrict to adjustments of specific products by product ID (as returned in each adjustment's product_id). Repeat the bracketed key once per ID; matches ANY. A malformed ID is rejected with a 400; an unknown-but-well-formed ID matches nothing; an empty list is no filter. At most 200 IDs.
Page selector. Page size is fixed by the server; paginate by following the next_page URL in each response rather than building page selectors yourself — it is null on the last page. next_page uses page[after]=<cursor>, an opaque token marking where the next page resumes; pass it back exactly as given, and only to the endpoint that issued it. This is seek-based, so every page stays fast no matter how deep you page.
Response
A list of stock adjustments
Changes
No recorded changes to this endpoint across all 1 revision of this API.