<back to all web services
GetStock
The following routes are available for this service:| GET | /stock/{brand} | Get stock | |
|---|
StockRequest Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| brand | form | string | Yes | Brand |
| posCodes | form | List<string> | No | POS Legacy |
| articleCodes | form | List<string> | No | Article Codes |
| includeExtraInfo | form | bool | No | Include Extra Info |
| clusterIds | form | List<string> | No | Cluster Id |
| includeConsignmentNotAuthorizedPOS | form | bool | No | Include Consignment NotAuthorized POS |
| includeRSP | form | bool | No | Include Retail Sales Price in the Output, by default: false |
| dateFrom | form | DateTime? | No | In Stock Since date from |
| dateTo | form | DateTime? | No | In Stock Since date to |
| type | form | string | No | Item type, 'standard' OR 'consigned'. By default, all are coming |
PosStockItem Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| brand | form | string | Yes | Brand |
| posCode | form | string | Yes | Pos Code |
| sharedStockLocation | form | Pos | Yes | Shared Stock Location |
| stockItems | form | List<StockItem> | No | Stock Items |
Pos Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| name | form | string | Yes | Name of the POS |
| posCode | form | string | Yes | POS Code |
| posCodeToBeDisplayed | form | string | Yes | Pos Code To Be Displayed |
| country | form | string | Yes | Country of the POS |
| city | form | string | Yes | City of the POS |
| postalCode | form | string | Yes | Postal Code |
| state | form | string | Yes | State |
| street | form | string | Yes | Street |
StockItem Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| articleCode | form | string | Yes | Article Code |
| currentStockQuantity | form | int | Yes | Current Stock Quantity |
| serialNumbers | form | List<string> | No | Serial Numbers |
| stockPositions | form | List<StockPositionItem> | Yes | Stock Item in Details |
StockPositionItem Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| quantity | form | int | Yes | Quantity |
| serialNumber | form | string | No | Serial Number |
| stockDate | form | string | Yes | Stock Date |
| loadedOnDate | form | string | Yes | Loaded On Date |
| type | form | string | Yes | Type e.g. consignment or standard |
| isConsignmentSellable | form | bool | Yes | Is Consignment Sellable |
| unitNetAmount | form | UnitNetAmount | No | Sell-In Price. Disclaimer: this data will be arriving empty/null due to DealerCost project still being in test phase. |
| retailSalesPrice | form | UnitNetAmount | No | Retail Sales Price |
UnitNetAmount Parameters:| 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 .jsv suffix or ?format=jsv
HTTP + JSV
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
GET /stock/{brand} HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
[
]