Contents
On this page

List Adjustments - Plugixa Inventory

GET /plugixa-inventory/v1/adjustments

List adjustments, drafts and finalized, one page at a time.

The user needs the plugixa_inventory_view capability (administrators have every inventory capability). With Pro Roles and permissions enforcing, their role must also allow reading adjustments. Needs Plugixa Inventory Pro with the Inventory adjustments app on in Plugixa Inventory -> App Manager; with it off, this route answers 404.

Request

GET https://your-site.example/wp-json/plugixa-inventory/v1/adjustments?adjustment_type__in=damage

Query parameters

Plus the list parameters every paged list accepts. search matches reference, reason, details. orderby accepts id, reference, adjustment_type, adjustment_date, status, created_at, modified_at. view=trash lists the trash instead.

The filters this list accepts: status, adjustment_type, warehouse_id, adjustment_date, created_at, modified_at.

Responses

200 OK. data is one page of adjustments.

{
  "success": true,
  "data": [
    {
      "id": 9,
      "reference": "",
      "adjustment_type": "damage",
      "warehouse_id": 1,
      "adjustment_date": "2026-11-12 10:30:00",
      "status": "draft",
      "finalized_at": null,
      "finalized_by": null,
      "batch_id": "",
      "line_count": 1,
      "total_quantity": 0.0,
      "total_cost": 0.0,
      "reason": "Leak in aisle 4",
      "details": "",
      "attachments": null,
      "assigned_user_id": null,
      "created_by": 1,
      "modified_by": 1,
      "created_at": "2026-11-12 09:30:00",
      "modified_at": "2026-11-12 09:30:00",
      "deleted_at": null,
      "warehouse_name": "Main warehouse"
    }
  ],
  "meta": {
    "total": 1,
    "pages": 1
  }
}
Field Type Meaning
data[].adjustment_type string addition, damage or subtraction
data.status string draft or finalized
data[].warehouse_name string|null The warehouse’s name
data[].line_count integer Lines on the document, counted live on a draft
meta.total integer Adjustments matching, before paging
meta.pages integer Number of pages at this per_page

List rows do not carry the lines. Get Adjustment does.

Errors

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-inventory/v1/adjustments?adjustment_type__in=damage" \
  -u "admin:$WP_APP_PASSWORD"
<?php
$query = http_build_query(['adjustment_type__in' => 'damage']);
$ch = curl_init('https://your-site.example/wp-json/plugixa-inventory/v1/adjustments?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const auth = 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`);
const query = new URLSearchParams({ adjustment_type__in: 'damage' });
const response = await fetch(`https://your-site.example/wp-json/plugixa-inventory/v1/adjustments?${query}`, {
  headers: { 'Authorization': auth },
});
const { data, meta } = await response.json();

Quick Links

Share