POST api/v1/Product/ReservationList
Gets the stock amounts
Request Information
URI Parameters
None.
Body Parameters
GetStockReservationListParameter| Name | Description | Type | Additional information |
|---|---|---|---|
| LocationName |
The name of the storage location the data is requested. When location not exists, an error will be thrown |
string |
None. |
| Limit |
The amount of rows requested per page. Default 50 |
integer |
None. |
| Page |
The requested page related to the limit. default 1 |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"LocationName": "sample string 1",
"Limit": 2,
"Page": 3
}
application/xml, text/xml
Sample:
<GetStockReservationListParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PromotionalOffice.WebApi.Models.Products"> <Limit>2</Limit> <LocationName>sample string 1</LocationName> <Page>3</Page> </GetStockReservationListParameter>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Collection of stock amount items.
GetStockReservationListResult| Name | Description | Type | Additional information |
|---|---|---|---|
| StockAmounts |
List of found reservations |
Collection of StockReservationItem |
None. |
Response Formats
application/json, text/json
Sample:
{
"StockAmounts": [
{
"ArticleOrderNumber": "sample string 1",
"OwnArticleNumber": "sample string 2",
"ProductIdentifier": "6bb4f5a1-b1ba-40e3-8961-78d9d46a7b02",
"ReservatedAmountTotalAmount": 4.0,
"ReservatedAmountTotalUnit": "sample string 5",
"VariationIdentifier": "489b7df7-60e4-4656-b243-50538a0792a5"
},
{
"ArticleOrderNumber": "sample string 1",
"OwnArticleNumber": "sample string 2",
"ProductIdentifier": "6bb4f5a1-b1ba-40e3-8961-78d9d46a7b02",
"ReservatedAmountTotalAmount": 4.0,
"ReservatedAmountTotalUnit": "sample string 5",
"VariationIdentifier": "489b7df7-60e4-4656-b243-50538a0792a5"
}
]
}
application/xml, text/xml
Sample:
<GetStockReservationListResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PromotionalOffice.WebApi.Models.Products">
<StockAmounts>
<GetStockReservationListResult.StockReservationItem>
<ArticleOrderNumber>sample string 1</ArticleOrderNumber>
<OwnArticleNumber>sample string 2</OwnArticleNumber>
<ProductIdentifier>6bb4f5a1-b1ba-40e3-8961-78d9d46a7b02</ProductIdentifier>
<ReservatedAmountTotalAmount>4</ReservatedAmountTotalAmount>
<ReservatedAmountTotalUnit>sample string 5</ReservatedAmountTotalUnit>
<VariationIdentifier>489b7df7-60e4-4656-b243-50538a0792a5</VariationIdentifier>
</GetStockReservationListResult.StockReservationItem>
<GetStockReservationListResult.StockReservationItem>
<ArticleOrderNumber>sample string 1</ArticleOrderNumber>
<OwnArticleNumber>sample string 2</OwnArticleNumber>
<ProductIdentifier>6bb4f5a1-b1ba-40e3-8961-78d9d46a7b02</ProductIdentifier>
<ReservatedAmountTotalAmount>4</ReservatedAmountTotalAmount>
<ReservatedAmountTotalUnit>sample string 5</ReservatedAmountTotalUnit>
<VariationIdentifier>489b7df7-60e4-4656-b243-50538a0792a5</VariationIdentifier>
</GetStockReservationListResult.StockReservationItem>
</StockAmounts>
</GetStockReservationListResult>