List Inventory¶
Required privilege: Inventory / View
Returns a paginated, filterable list of inventory records.
Response¶
{
"data": {
"headers": [
{ "key": "Item Number", "format": "string-link" },
{ "key": "Item Description", "format": "string" },
{ "key": "Warehouse Number", "format": "string-link" },
{ "key": "Inventory Quantity", "format": "number" },
{ "key": "Inventory Date", "format": "date" }
],
"rows": [
{
"id": 601,
"Item Id": 55,
"Item Number": "ITEM-A",
"Item Description": "Widget Assembly - Type A",
"Warehouse Id": 3,
"Warehouse Number": "WH-01",
"Warehouse Name": "Main Distribution Center",
"Inventory Quantity": 850,
"Inventory Date": "2024-03-01",
"Inventory Unique Id": null
}
]
}
}
| Field | Type | Description |
|---|---|---|
id |
integer | Internal inventory record ID |
Item Number |
string | Item reference |
Warehouse Number |
string | Warehouse reference |
Inventory Quantity |
number | On-hand quantity |
Inventory Date |
string | null | Record date |