GET api/Inventories/{id}?WarehouseId={WarehouseId}&EndDate={EndDate}

Retrieves the inventory levels for an item in a warehouse at the end of a supplied date.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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

EndDate

If not supplied, then the current date will be used. If supplied, then the inventory will be retrieved for the balances at the end of the day on the supplied date.

date

Required

Body Parameters

None.

Response Information

Resource Description

Inventory
NameDescriptionTypeAdditional information
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.

ItemQuantity

Inventory level of the item.

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "WarehouseId": 2,
  "ItemId": 3,
  "SKU": "sample string 4",
  "SKU2": "sample string 5",
  "ItemName": "sample string 6",
  "ItemQuantity": 7
}

application/xml, text/xml

Sample:
<Inventory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCBGSAPI.Models">
  <InventoryId>1</InventoryId>
  <ItemId>3</ItemId>
  <ItemName>sample string 6</ItemName>
  <ItemQuantity>7</ItemQuantity>
  <SKU>sample string 4</SKU>
  <SKU2>sample string 5</SKU2>
  <WarehouseId>2</WarehouseId>
</Inventory>