GET api/inventory/ItemCode/{ItemCode}

Get current inventory levels for a specific item using itemCode.

Request Information

URI Parameters

Name Type Description Additional information
ItemCode string

Required

Body Parameters

None

Response Information

Resource Description

Inventory
Name Type Description Additional information
ItemCode string

Item Code

ItemNumber string

Item Number

Warehouse string

Warehouse where inventory is located

OnHandQuantity decimal number

On hand Quantity

ShippableQuantity decimal number

Shippable Quantity

CommittedQuantity decimal number

Committed Quantity

ReserveQuantity decimal number

Reserved Quantity

UnitOfMeasure string

Unit of Measure

LastUpdateDateTime date

Last updated time in UTC

QuarantineQuantity decimal number

InventoryDetails Collection of ItemInventoryDetailV1

Details about inventory

Response Formats

application/json, text/json

Sample: 
{
  "ItemCode": "sample string 1",
  "ItemNumber": "sample string 2",
  "Warehouse": "sample string 3",
  "OnHandQuantity": 4.0,
  "ShippableQuantity": 5.0,
  "CommittedQuantity": 6.0,
  "ReserveQuantity": 7.0,
  "UnitOfMeasure": "sample string 8",
  "LastUpdateDateTime": "2024-10-13T22:56:28.9773958+00:00",
  "QuarantineQuantity": 10.0,
  "InventoryDetails": [
    {
      "ItemCode": "sample string 1",
      "ItemNumber": "sample string 2",
      "Location": "sample string 3",
      "LotExpirationDate": "2024-10-13T22:56:28.9773958+00:00",
      "LotNumber": "sample string 4",
      "LotStatus": "sample string 5",
      "LicensePlate": "sample string 6",
      "Quantity": 7.0,
      "UnitOfMeasure": "sample string 8",
      "Warehouse": "sample string 9"
    },
    {
      "ItemCode": "sample string 1",
      "ItemNumber": "sample string 2",
      "Location": "sample string 3",
      "LotExpirationDate": "2024-10-13T22:56:28.9773958+00:00",
      "LotNumber": "sample string 4",
      "LotStatus": "sample string 5",
      "LicensePlate": "sample string 6",
      "Quantity": 7.0,
      "UnitOfMeasure": "sample string 8",
      "Warehouse": "sample string 9"
    }
  ]
}

application/xml, text/xml

Sample: 
<Inventory xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ItemCode>sample string 1</ItemCode>
  <ItemNumber>sample string 2</ItemNumber>
  <Warehouse>sample string 3</Warehouse>
  <OnHandQuantity>4</OnHandQuantity>
  <ShippableQuantity>5</ShippableQuantity>
  <CommittedQuantity>6</CommittedQuantity>
  <ReserveQuantity>7</ReserveQuantity>
  <UnitOfMeasure>sample string 8</UnitOfMeasure>
  <LastUpdateDateTime>2024-10-13T22:56:28.9773958+00:00</LastUpdateDateTime>
  <QuarantineQuantity>10</QuarantineQuantity>
  <InventoryDetails>
    <ItemInventoryDetailV1>
      <ItemCode>sample string 1</ItemCode>
      <ItemNumber>sample string 2</ItemNumber>
      <Location>sample string 3</Location>
      <LotExpirationDate>2024-10-13T22:56:28.9773958+00:00</LotExpirationDate>
      <LotNumber>sample string 4</LotNumber>
      <LotStatus>sample string 5</LotStatus>
      <LicensePlate>sample string 6</LicensePlate>
      <Quantity>7</Quantity>
      <UnitOfMeasure>sample string 8</UnitOfMeasure>
      <Warehouse>sample string 9</Warehouse>
    </ItemInventoryDetailV1>
    <ItemInventoryDetailV1>
      <ItemCode>sample string 1</ItemCode>
      <ItemNumber>sample string 2</ItemNumber>
      <Location>sample string 3</Location>
      <LotExpirationDate>2024-10-13T22:56:28.9773958+00:00</LotExpirationDate>
      <LotNumber>sample string 4</LotNumber>
      <LotStatus>sample string 5</LotStatus>
      <LicensePlate>sample string 6</LicensePlate>
      <Quantity>7</Quantity>
      <UnitOfMeasure>sample string 8</UnitOfMeasure>
      <Warehouse>sample string 9</Warehouse>
    </ItemInventoryDetailV1>
  </InventoryDetails>
</Inventory>