GET v1/Warehouses/{warehouseId}/Stock
Get a list with all product stock available in the Warehouse, grouped by ProductCode.
Request Information
Requires Authorization!
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
warehouseId |
The Warehouse Id |
integer |
Required. |
Body Parameters
None.
Response Information
Resource Description
A list of ProductStockInfo objects.
Collection of ProductStockInfo
Name | Description | Type | Additional information |
---|---|---|---|
ProductCode |
Gets or sets the product code. |
string |
None. |
ProductId |
Gets or sets the product identifier. |
integer |
None. |
QtyOnHand |
Gets or sets the qty on hand. |
decimal number |
None. |
QtyAvailable |
Gets the qty available. |
decimal number |
None. |
QtyReserved |
Gets or sets the qty reserved. |
decimal number |
None. |
Response Formats
application/json, text/json
Sample:
[ { "ProductCode": "sample string 1", "ProductId": 2, "QtyOnHand": 3.0, "QtyAvailable": -1.0, "QtyReserved": 4.0 }, { "ProductCode": "sample string 1", "ProductId": 2, "QtyOnHand": 3.0, "QtyAvailable": -1.0, "QtyReserved": 4.0 } ]
application/xml, text/xml
Sample:
<ArrayOfProductStockInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ProductStockInfo> <ProductCode>sample string 1</ProductCode> <ProductId>2</ProductId> <QtyOnHand>3</QtyOnHand> <QtyReserved>4</QtyReserved> </ProductStockInfo> <ProductStockInfo> <ProductCode>sample string 1</ProductCode> <ProductId>2</ProductId> <QtyOnHand>3</QtyOnHand> <QtyReserved>4</QtyReserved> </ProductStockInfo> </ArrayOfProductStockInfo>