GET v1/Products/{productId}/StockPerLocation
Get a list with all available stock per WarehouseLocation.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| productId |
The Product Id |
integer |
Required. |
Body Parameters
None.
Response Information
Resource Description
A list of ProductStockLocationInfo objects.
Collection of ProductStockLocationInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| WarehouseId |
Gets or sets the warehouse identifier. |
integer |
None. |
| WarehouseType |
Gets or sets the warehouse type |
WarehouseTypeEnum |
None. |
| WarehouseLocationId |
Gets or sets the warehouse location identifier. |
integer |
None. |
| 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:
[
{
"WarehouseId": 1,
"WarehouseType": 1,
"WarehouseLocationId": 2,
"ProductCode": "sample string 3",
"ProductId": 4,
"QtyOnHand": 5.0,
"QtyAvailable": -1.0,
"QtyReserved": 6.0
},
{
"WarehouseId": 1,
"WarehouseType": 1,
"WarehouseLocationId": 2,
"ProductCode": "sample string 3",
"ProductId": 4,
"QtyOnHand": 5.0,
"QtyAvailable": -1.0,
"QtyReserved": 6.0
}
]
application/xml, text/xml
Sample:
<ArrayOfProductStockLocationInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ProductStockLocationInfo>
<WarehouseId>1</WarehouseId>
<WarehouseType>Private</WarehouseType>
<WarehouseLocationId>2</WarehouseLocationId>
<ProductCode>sample string 3</ProductCode>
<ProductId>4</ProductId>
<QtyOnHand>5</QtyOnHand>
<QtyReserved>6</QtyReserved>
</ProductStockLocationInfo>
<ProductStockLocationInfo>
<WarehouseId>1</WarehouseId>
<WarehouseType>Private</WarehouseType>
<WarehouseLocationId>2</WarehouseLocationId>
<ProductCode>sample string 3</ProductCode>
<ProductId>4</ProductId>
<QtyOnHand>5</QtyOnHand>
<QtyReserved>6</QtyReserved>
</ProductStockLocationInfo>
</ArrayOfProductStockLocationInfo>