| GET | /buyin/{brand} | Get list of buyin | Get list of paginated buyin based on the search parameters submitted |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| brand | path | string | Yes | Richemont Brand ID |
| posCode | query | string | Yes | Richemont POS code |
| articleCode | query | string | Yes | Richemont Reference Code of the item |
| serialNumber | query | string | Yes | Serial Number of the item |
| buyInStatusId | query | string | Yes | Buy-in order status code |
| isInStock | query | bool? | No | True is the buy-in’s piece is in stock, False otherwise |
| page | query | int | Yes | Index of the result set returned |
| items | query | int | Yes | Size of the result set returned |
| noCount | query | bool | No | Omit precise record count - save on performance |
| sortBy | query | string | Yes | Sort Expression, Possible values: 'SaleDetailIdDESC', 'DocumentDate'. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| page | form | int | Yes | Index of the result set returnedr |
| items | form | int | Yes | Size of the result set returned |
| totalPages | form | int | Yes | Total amount of pages / result sets |
| totalResults | form | int | Yes | Total amount of results |
| elements | form | IEnumerable<BuyIn> | Yes | List of Sale Details |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| brand | form | string | Yes | Brand Trigram, e.g. CAR, IWC; compulsory only if articleCode is not provided |
| buyInOrderId | form | int | Yes | Code of BuyIn |
| posCode | form | string | Yes | Richemont POS code |
| articleCode | form | string | Yes | Richemont Reference Code of the item |
| serialNumber | form | string | Yes | Serial Number of the item |
| buyInStatusId | form | string | Yes | Buy-in order status code |
| buyInDate | form | DateTime | No | Buy-in creation date |
| saleRepresentativeEmails | form | List<string> | Yes | Emails of Sale Representatives |
| isInStock | form | bool | No | True is the buy-in’s piece is in stock, False otherwise |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /buyin/{brand} HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"page":0,"items":0,"totalPages":0,"totalResults":0}