Skip to content

Get Inventory Record

GET /api/inventory/{id}

Required privilege: Inventory / View

Returns a single inventory record.


Path Parameters

Parameter Type Required Description
id integer Yes Internal inventory record identifier

Response

{
  "data": {
    "id": 601,
    "Item Id": 55,
    "Item Number": "ITEM-A",
    "Item Description": "Widget Assembly - Type A",
    "Sub Item Id": null,
    "Sub Item Number": null,
    "Warehouse Id": 3,
    "Warehouse Number": "WH-01",
    "Warehouse Name": "Main Distribution Center",
    "Inventory Quantity": 850,
    "Inventory Date": "2024-03-01",
    "Inventory Unique Id": "ERP-INV-001"
  }
}

Errors

Status Code Description
400 Inventory.NotFound No inventory record with this ID
403 User.NotPrivileged Insufficient privilege