GET api/v1/ItemInventory/itemCode/{itemCode}

Get Item by item code

Request Information

URI Parameters

Name	Description	Type	Additional information
itemCode	Item code to return	string	Required

Body Parameters

Response Information

Resource Description

ItemInventory

Name	Description	Type
Id		integer
ItemId		integer
WarehouseId		integer
Balance		decimal number
CommittedBalance		decimal number
ShippableBalance		decimal number
ReserveBalance		decimal number
ItemCode		string
ItemDescription		string
WarehouseName		string
ItemInventoryDetails		Collection of ItemInventoryDetail
ModifiedDateTime	Modified datetime for the object. This will be added by the system.	date
ExecutionTime	How long the method took in milliseconds. System supplied value.	integer
TxID	Transaction ID of the call. Will be added for the response. Not needed in the request.	string

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "itemId": 2,
  "warehouseId": 3,
  "balance": 4.0,
  "committedBalance": 5.0,
  "shippableBalance": 6.0,
  "reserveBalance": 7.0,
  "itemCode": "sample string 8",
  "itemDescription": "sample string 9",
  "warehouseName": "sample string 10",
  "itemInventoryDetails": [
    {
      "id": 1,
      "itemInventoryId": 2,
      "warehouseId": 3,
      "detailBalance": 4.0,
      "detailCommitted": 5.0,
      "receiveAmount": 6.0,
      "recieveDate": "2025-08-14T01:25:38.7267965+00:00",
      "reserveBalance": 8.0,
      "lotNumber": "sample string 9",
      "lotBalance": 10.0,
      "lotExpiration": "2025-08-14T01:25:38.7267965+00:00",
      "modifiedDateTime": "2025-08-14T01:25:38.7267965+00:00",
      "executionTime": 14,
      "txID": "sample string 15"
    },
    {
      "id": 1,
      "itemInventoryId": 2,
      "warehouseId": 3,
      "detailBalance": 4.0,
      "detailCommitted": 5.0,
      "receiveAmount": 6.0,
      "recieveDate": "2025-08-14T01:25:38.7267965+00:00",
      "reserveBalance": 8.0,
      "lotNumber": "sample string 9",
      "lotBalance": 10.0,
      "lotExpiration": "2025-08-14T01:25:38.7267965+00:00",
      "modifiedDateTime": "2025-08-14T01:25:38.7267965+00:00",
      "executionTime": 14,
      "txID": "sample string 15"
    }
  ],
  "modifiedDateTime": "2025-08-14T01:25:38.7267965+00:00",
  "executionTime": 13,
  "txID": "sample string 14"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.