List Adjustments
GET /adjustments
List stock adjustments
Scope adjustments:read; role permission inventory.manage_adjustments; needs the Adjustments app.
Request
GET https://example.com/api/index.php/v1/nextinventory/adjustments?limit=<integer>&offset=<integer>&search=<string>&is_draft=<integer>&adjustment_type=<string>&warehouse_id=<integer>&date_from=<string>&date_to=<string>
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
limit |
integer |
query |
No | Page size. (min 1) Defaults to 20. |
offset |
integer |
query |
No | Rows to skip. (min 0) Defaults to 0. |
search |
string |
query |
No | |
is_draft |
integer |
query |
No | One of 0, 1. |
adjustment_type |
string |
query |
No | One of addition, damage, subtraction. |
warehouse_id |
integer |
query |
No | |
date_from |
string |
query |
No | (date) |
date_to |
string |
query |
No | (date) |
Responses
200 — A page of adjustments.
{
"data": [
{
"id": 1,
"reference": "string",
"adjustment_date": "2026-01-01",
"adjustment_type": "addition",
"warehouse_id": 1,
"warehouse_title": "string",
"details": "string",
"is_draft": true,
"created": "2026-01-01T12:00:00Z",
"created_by": 1,
"modified": "2026-01-01T12:00:00Z"
}
],
"meta": {
"total": 1
}
}
| Field | Type | Meaning |
|---|---|---|
data[].id |
integer |
|
data[].reference |
string|null |
|
data[].adjustment_date |
string|null |
(date) |
data[].adjustment_type |
string |
One of addition, damage, subtraction. |
data[].warehouse_id |
integer|null |
|
data[].warehouse_title |
string|null |
|
data[].details |
string|null |
|
data[].is_draft |
boolean |
|
data[].created |
string|null |
(date-time) |
data[].created_by |
integer |
|
data[].modified |
string|null |
(date-time) |
meta.total |
integer |
Rows matching the filters, across all pages. |
Errors
| Status | Code | When |
|---|---|---|
4 |
A refusal. Common codes: MISSING_TOKEN / INVALID_TOKEN (401); API_DISABLED, ACCOUNT_UNUSABLE, ACCESS_DENIED, TASK_NOT_ALLOWED, MISSING_SCOPE, APP_DISABLED, DEMO_LOCKED, FORBIDDEN (403); NOT_FOUND (404); BAD_REQUEST / INVALID_JSON / INVALID_IDEMPOTENCY_KEY (400, validation and stock rules, with the reason in title); IDEMPOTENCY_IN_PROGRESS (409); PRECONDITION_FAILED (412, the record changed since the If-Match ETag was read); IDEMPOTENCY_KEY_REUSED (422); RATE_LIMITED / TOO_MANY_FAILED_LOGINS (429, with a Retry-After header in seconds); SERVER_ERROR (500). |
Examples
curl
curl -s "https://example.com/api/index.php/v1/nextinventory/adjustments" \
-H "Authorization: Bearer $API_TOKEN"
PHP
<?php
$ch = curl_init('https://example.com/api/index.php/v1/nextinventory/adjustments?limit=<integer>&offset=<integer>&search=<string>&is_draft=<integer>&adjustment_type=<string>&warehouse_id=<integer>&date_from=<string>&date_to=<string>');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('API_TOKEN'),
],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
JavaScript
const API_TOKEN = process.env.API_TOKEN;
const response = await fetch("https://example.com/api/index.php/v1/nextinventory/adjustments?limit=<integer>&offset=<integer>&search=<string>&is_draft=<integer>&adjustment_type=<string>&warehouse_id=<integer>&date_from=<string>&date_to=<string>", {
headers: {
"Authorization": `Bearer ${API_TOKEN}`,
},
});
const data = await response.json();