Create Adjustment
POST /adjustments
Record found, damaged or lost stock
Scope adjustments:write. is_draft: false finalizes at once.
Request
POST https://example.com/api/index.php/v1/nextinventory/adjustmentsParameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
Idempotency-Key |
string |
header |
No | Optional. Any unique string (1 to 191 printable ASCII characters, no spaces; a UUID is ideal). The request runs once: a retry with the same key gets the first response back, with the header Idempotent-Replayed: true, instead of running again. Keys are kept for 24 hours per token. 409 IDEMPOTENCY_IN_PROGRESS while the first request is still running; 422 IDEMPOTENCY_KEY_REUSED if the key comes with a different request. A 5xx answer is not kept, so it can be retried with the same key. (min length 1, max length 191, pattern ^[\x21-\x7E]+$) |
Request body
Content type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
adjustment_date |
string |
Yes | (date) |
adjustment_type |
string |
Yes | One of addition, damage, subtraction. |
warehouse_id |
integer |
Yes | |
reference |
string |
No | |
details |
string |
No | |
is_draft |
boolean |
No | Defaults to true. |
items |
object[] |
Yes | |
items.item_id |
integer |
Yes | |
items.quantity |
number |
Yes |
{
"adjustment_date": "2026-11-11",
"adjustment_type": "damage",
"warehouse_id": 1,
"details": "Water damage",
"is_draft": false,
"items": [
{
"item_id": 17,
"quantity": 2
}
]
}Responses
201 — Created.
{
"data": {
"id": 1
}
}| Field | Type | Meaning |
|---|---|---|
data.id |
integer |
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 -X POST "https://example.com/api/index.php/v1/nextinventory/adjustments" \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"adjustment_date":"2026-11-11","adjustment_type":"damage","warehouse_id":1,"details":"Water damage","is_draft":false,"items":[{"item_id":17,"quantity":2}]}'PHP
<?php
$ch = curl_init('https://example.com/api/index.php/v1/nextinventory/adjustments');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('API_TOKEN'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => '{"adjustment_date":"2026-11-11","adjustment_type":"damage","warehouse_id":1,"details":"Water damage","is_draft":false,"items":[{"item_id":17,"quantity":2}]}',
]);
$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", {
method: 'POST',
headers: {
"Authorization": `Bearer ${API_TOKEN}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"adjustment_date": "2026-11-11",
"adjustment_type": "damage",
"warehouse_id": 1,
"details": "Water damage",
"is_draft": false,
"items": [
{
"item_id": 17,
"quantity": 2
}
]
}),
});
const data = await response.json();