GET api/InventoryDetails/{id}?WarehouseId={WarehouseId}

Retrieves the inventory details for each active inventory unit for a specific item in a warehouse.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ItemId from the BGS system.	integer	Required
WarehouseId	The WarehouseId from the BGS system. Acceptable values are: 1 (for Memphis, TN) or 2 (for Salt Lake City, UT)	integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of InventoryDetail

Name	Description	Type	Additional information
InventoryUnitId	Unique inventory unit identifier from the BGS system that is assigned to every inventory unit at creation.	integer	None.
ClientUnitId	Inventory unit identifier assigned by the client.	string	None.
WarehouseId	Acceptable values are: 1 (for Memphis, TN) or 2 (for Salt Lake City, UT)	integer	None.
ItemId	Unique identifier from the BGS system that is assigned at item creation, and it can be used as the id parameter.	integer	None.
SKU	SKU identifier assigned to the item.	string	None.
SKU2	An alternate SKU identifier assigned to the item.	string	None.
ItemName	Name/Description given to the item.	string	None.
Lot	Lot number for the inventory unit.	string	None.
ExpirationDate	Expiration date of the lot.	date	Data type: Date
ItemQuantity	Inventory level of the inventory unit.	integer	None.
UnitStatus	Displays the unit's current status.	string	None.
IncludedInInventory	Indicates whether or not the inventory status above is included in the good and useable inventory. For example, statuses such as Quarantine or On Hold would not be included in the inventory calculations or be used for orders.	boolean	None.
InventoryUnitNotes	Contains any notes or observations made about the inventory unit.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "InventoryUnitId": 2,
    "ClientUnitId": "sample string 3",
    "WarehouseId": 4,
    "ItemId": 5,
    "SKU": "sample string 6",
    "SKU2": "sample string 7",
    "ItemName": "sample string 8",
    "Lot": "sample string 9",
    "ExpirationDate": "2025-12-14T15:23:39.9591443+00:00",
    "ItemQuantity": 10,
    "UnitStatus": "sample string 11",
    "IncludedInInventory": true,
    "InventoryUnitNotes": "sample string 13"
  },
  {
    "InventoryUnitId": 2,
    "ClientUnitId": "sample string 3",
    "WarehouseId": 4,
    "ItemId": 5,
    "SKU": "sample string 6",
    "SKU2": "sample string 7",
    "ItemName": "sample string 8",
    "Lot": "sample string 9",
    "ExpirationDate": "2025-12-14T15:23:39.9591443+00:00",
    "ItemQuantity": 10,
    "UnitStatus": "sample string 11",
    "IncludedInInventory": true,
    "InventoryUnitNotes": "sample string 13"
  }
]

application/xml, text/xml

Sample:

<ArrayOfInventoryDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCBGSAPI.Models">
  <InventoryDetail>
    <ClientUnitId>sample string 3</ClientUnitId>
    <ExpirationDate>2025-12-14T15:23:39.9591443+00:00</ExpirationDate>
    <IncludedInInventory>true</IncludedInInventory>
    <InventoryDetailId>1</InventoryDetailId>
    <InventoryUnitId>2</InventoryUnitId>
    <InventoryUnitNotes>sample string 13</InventoryUnitNotes>
    <ItemId>5</ItemId>
    <ItemName>sample string 8</ItemName>
    <ItemQuantity>10</ItemQuantity>
    <Lot>sample string 9</Lot>
    <SKU>sample string 6</SKU>
    <SKU2>sample string 7</SKU2>
    <UnitStatus>sample string 11</UnitStatus>
    <WarehouseId>4</WarehouseId>
  </InventoryDetail>
  <InventoryDetail>
    <ClientUnitId>sample string 3</ClientUnitId>
    <ExpirationDate>2025-12-14T15:23:39.9591443+00:00</ExpirationDate>
    <IncludedInInventory>true</IncludedInInventory>
    <InventoryDetailId>1</InventoryDetailId>
    <InventoryUnitId>2</InventoryUnitId>
    <InventoryUnitNotes>sample string 13</InventoryUnitNotes>
    <ItemId>5</ItemId>
    <ItemName>sample string 8</ItemName>
    <ItemQuantity>10</ItemQuantity>
    <Lot>sample string 9</Lot>
    <SKU>sample string 6</SKU>
    <SKU2>sample string 7</SKU2>
    <UnitStatus>sample string 11</UnitStatus>
    <WarehouseId>4</WarehouseId>
  </InventoryDetail>
</ArrayOfInventoryDetail>