GET api/inventory?itemIdentifier={itemIdentifier}

Get inventory details for a specified item identifier. First checks the product's Sku then UPC then Manufacturer Number.

Request Information

Parameters

NameDescriptionAdditional information
itemIdentifier
The product's item identifier.

Define this parameter in the request URI.

Response Information

Inventory details for the specified item identifier.

Response body formats

application/json, text/json

Sample:
{
  "Sku": "sample string 1",
  "Name": "sample string 2",
  "Upc": "sample string 3",
  "ManufacturerNumber": "sample string 4",
  "LocationInventories": [
    {
      "LocationId": 1,
      "AvailableQuantity": 2,
      "QuantityOnHand": 3
    },
    {
      "LocationId": 1,
      "AvailableQuantity": 2,
      "QuantityOnHand": 3
    },
    {
      "LocationId": 1,
      "AvailableQuantity": 2,
      "QuantityOnHand": 3
    }
  ],
  "DateModified": "2024-11-21T05:01:55.5153285-05:00",
  "Sellable": true
}

application/xml, text/xml

Sample:
<Inventory xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Sku>sample string 1</Sku>
  <Name>sample string 2</Name>
  <Upc>sample string 3</Upc>
  <ManufacturerNumber>sample string 4</ManufacturerNumber>
  <LocationInventories>
    <LocationInventory>
      <LocationId>1</LocationId>
      <AvailableQuantity>2</AvailableQuantity>
      <QuantityOnHand>3</QuantityOnHand>
    </LocationInventory>
    <LocationInventory>
      <LocationId>1</LocationId>
      <AvailableQuantity>2</AvailableQuantity>
      <QuantityOnHand>3</QuantityOnHand>
    </LocationInventory>
    <LocationInventory>
      <LocationId>1</LocationId>
      <AvailableQuantity>2</AvailableQuantity>
      <QuantityOnHand>3</QuantityOnHand>
    </LocationInventory>
  </LocationInventories>
  <DateModified>2024-11-21T05:01:55.5153285-05:00</DateModified>
  <Sellable>true</Sellable>
</Inventory>