GET api/v2/products/GetInventoryList?filterCode={filterCode}&warehouseCode={warehouseCode}
Get list of inventory for all warehouses or for a specific warehouse
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
filterCode |
an optional filter code used to filter the result product list |
string |
None. |
warehouseCode |
an optional warehouse code to get inventory for |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of WarehouseInventoryName | Description | Type | Additional information |
---|---|---|---|
InventoryList | Collection of Inventory |
None. |
|
WarehouseCode | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "WarehouseCode": "sample string 1", "InventoryList": [ { "ProductNumber": "sample string 1", "QtyAvail": 2, "Incoming": [ { "Qty": 1, "Eta": "sample string 2" }, { "Qty": 1, "Eta": "sample string 2" } ] }, { "ProductNumber": "sample string 1", "QtyAvail": 2, "Incoming": [ { "Qty": 1, "Eta": "sample string 2" }, { "Qty": 1, "Eta": "sample string 2" } ] } ] }, { "WarehouseCode": "sample string 1", "InventoryList": [ { "ProductNumber": "sample string 1", "QtyAvail": 2, "Incoming": [ { "Qty": 1, "Eta": "sample string 2" }, { "Qty": 1, "Eta": "sample string 2" } ] }, { "ProductNumber": "sample string 1", "QtyAvail": 2, "Incoming": [ { "Qty": 1, "Eta": "sample string 2" }, { "Qty": 1, "Eta": "sample string 2" } ] } ] } ]
application/xml, text/xml
Sample:
<ArrayOfWarehouseInventory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CoasterAPI.Products"> <WarehouseInventory> <InventoryList> <Inventory> <Incoming> <InventoryETA> <Eta>sample string 2</Eta> <Qty>1</Qty> </InventoryETA> <InventoryETA> <Eta>sample string 2</Eta> <Qty>1</Qty> </InventoryETA> </Incoming> <ProductNumber>sample string 1</ProductNumber> <QtyAvail>2</QtyAvail> </Inventory> <Inventory> <Incoming> <InventoryETA> <Eta>sample string 2</Eta> <Qty>1</Qty> </InventoryETA> <InventoryETA> <Eta>sample string 2</Eta> <Qty>1</Qty> </InventoryETA> </Incoming> <ProductNumber>sample string 1</ProductNumber> <QtyAvail>2</QtyAvail> </Inventory> </InventoryList> <WarehouseCode>sample string 1</WarehouseCode> </WarehouseInventory> <WarehouseInventory> <InventoryList> <Inventory> <Incoming> <InventoryETA> <Eta>sample string 2</Eta> <Qty>1</Qty> </InventoryETA> <InventoryETA> <Eta>sample string 2</Eta> <Qty>1</Qty> </InventoryETA> </Incoming> <ProductNumber>sample string 1</ProductNumber> <QtyAvail>2</QtyAvail> </Inventory> <Inventory> <Incoming> <InventoryETA> <Eta>sample string 2</Eta> <Qty>1</Qty> </InventoryETA> <InventoryETA> <Eta>sample string 2</Eta> <Qty>1</Qty> </InventoryETA> </Incoming> <ProductNumber>sample string 1</ProductNumber> <QtyAvail>2</QtyAvail> </Inventory> </InventoryList> <WarehouseCode>sample string 1</WarehouseCode> </WarehouseInventory> </ArrayOfWarehouseInventory>