| GET | /stock/{brand}/{posCode} | Get Paginated Stock |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| brand | path | string | Yes | Brand |
| posCode | path | string | Yes | POS Legacy |
| searchKey | query | string | No | Search Key (Article or SerialNumber) |
| page | query | int | No | Index of the result set returned |
| items | query | int | No | Size of the result set returned |
| noCount | query | bool | No | Omit precise record count - save on performance |
| sortBy | query | string | No | Sorting expression |
| includeChainPosesStock | query | bool | No | Parameter - Include Chain POSes Stock |
| includeRSP | query | bool | No | Include Retail Sales Price in the Output, by default: false |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| totalPages | form | int | Yes | Total Pages |
| totalResults | form | int | Yes | Total Results |
| page | form | int | Yes | Index of the result set returned |
| items | form | int | Yes | Size of the result set returned |
| elements | form | IEnumerable<PaginatedStockElement> | Yes | List of movements |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| posCode | form | string | Yes | Pos Code |
| posCodeToBeDisplayed | form | string | Yes | Pos Code To Be Displayed |
| articleCode | form | string | Yes | Article Code |
| serialNumber | form | string | No | Serial Number |
| quantity | form | int | Yes | Current Stock Quantity |
| type | form | string | Yes | Type e.g. consignment or standard |
| isConsignmentSellable | form | bool | Yes | Is Consignment Sellable |
| retailSalesPrice | form | RetailSalesPrice | Yes | Retail Sales Price |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| currencyIsoCode | form | string | Yes | Currency Iso Code |
| value | form | decimal? | Yes | Value |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /stock/{brand}/{posCode} HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GetStockPaginatedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Stock.ServiceModel"> <elements i:nil="true" /> <items>0</items> <page>0</page> <totalPages>0</totalPages> <totalResults>0</totalResults> </GetStockPaginatedResponse>