Contents
On this page

Get Item - Plugixa Inventory

GET /plugixa-inventory/v1/items/{id}

Read one item.

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 items.

Request

GET https://your-site.example/wp-json/plugixa-inventory/v1/items/42

Path parameters

Name Type Description
id integer The item’s id

Responses

200 OK. data is the item.

{
  "success": true,
  "data": {
    "id": 42,
    "name": "Printer paper A4",
    "sku": "PAP-A4",
    "barcode": "3045140105502",
    "serial_number": "",
    "item_type": "consumable",
    "category_id": 3,
    "default_warehouse_id": 1,
    "unit_id": null,
    "image_id": null,
    "stock_quantity": 120.0,
    "reorder_level": 20.0,
    "unit_price": 6.9,
    "cost_price": 4.2,
    "weight": 2.5,
    "weight_unit": "kg",
    "weight_base": 2.5,
    "track_weight": false,
    "status": "published",
    "description": "",
    "custom_fields": null,
    "assigned_user_id": null,
    "created_by": 1,
    "modified_by": 1,
    "created_at": "2026-11-12 09:30:00",
    "modified_at": "2026-11-12 10:15:00",
    "deleted_at": null,
    "image_url": null,
    "image_url_medium": null,
    "category_name": "Office supplies",
    "warehouse_name": "Main warehouse",
    "unit_name": null
  }
}
Field Type Meaning
data.id integer The item’s id
data.stock_quantity number Total on hand across all warehouses. Changes only when a stock document is finalized
data.item_type string asset, consumable or sellable
data.category_id integer|null The category, or null
data.category_name string|null The category’s name
data.default_warehouse_id integer|null The default warehouse, or null
data.warehouse_name string|null The default warehouse’s name
data.unit_id integer|null The unit PRO, or null
data.unit_name string|null The unit’s code
data.weight_base number The weight converted to kilograms, worked out for you
data.track_weight boolean Whether the weight is tracked
data.image_url string|null Thumbnail URL of the image
data.image_url_medium string|null Medium-size URL of the image, or the thumbnail when there is no medium size
data.custom_fields object|null The Pro custom field values, when custom fields are defined for items
data.created_at string UTC datetime
data.deleted_at string|null null unless the item is in the trash

Errors

Status Code When
404 plugixa_inventory_not_found No item with that id, or it is in the trash.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-inventory/v1/items/42" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-inventory/v1/items/42');
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 response = await fetch('https://your-site.example/wp-json/plugixa-inventory/v1/items/42', {
  headers: { 'Authorization': auth },
});
const { data } = await response.json();

Quick Links

Share