Get Inventory by Item
GET /api/inventory-item/{item_id}
GET /api/inventory-item/{item_id}/{warehouse_id}
Required privilege: Inventory / View
Returns inventory data for a specific item, aggregated across all warehouses or scoped to one. The response includes both inventory levels and associated order demand.
Path Parameters
| Parameter |
Type |
Required |
Description |
item_id |
integer |
Yes |
Internal Item Master identifier |
warehouse_id |
integer |
No |
Internal Warehouse Master identifier |
Response
{
"data": {
"item": {
"Item Number": "ITEM-A",
"Item Description": "Widget Assembly - Type A",
"Item Type": "Finished Good",
"Total Quantity": 1200,
"Total Warehouses": 2
},
"orders": {
"headers": [
{ "key": "Warehouse Number", "format": "string-link" },
{ "key": "Inventory Quantity", "format": "number" },
{ "key": "Open PO Quantity", "format": "number" },
{ "key": "Open SO Quantity", "format": "number" },
{ "key": "Open MO Quantity", "format": "number" }
],
"rows": [
{
"Warehouse Number": "WH-01",
"Warehouse Name": "Main Distribution Center",
"Inventory Quantity": 850,
"Open PO Quantity": 200,
"Open SO Quantity": 300,
"Open MO Quantity": 500,
"Net Available": 750
}
]
}
}
}
item Summary Fields
| Field |
Type |
Description |
Total Quantity |
number |
Total on-hand across all warehouses |
Total Warehouses |
integer |
Number of warehouses with stock |
orders Row Fields
| Field |
Type |
Description |
Inventory Quantity |
number |
Current on-hand quantity |
Open PO Quantity |
number |
Quantity on open purchase orders (inbound) |
Open SO Quantity |
number |
Quantity on open sales orders (outbound) |
Open MO Quantity |
number |
Quantity being manufactured |
Net Available |
number |
Inventory + inbound − outbound |
Code Examples
curl -b cookies.txt "https://acme.knosc.com/api/inventory-item/55"
curl -b cookies.txt "https://acme.knosc.com/api/inventory-item/55/3"