| POST | /warranty/{brand}/export | Export Sell-Out Data | Create a sell-out in a POS you are authorised for |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| brand | path | string | Yes | Brand Trigram, e.g. CAR, IWC |
| posCodes | body | List<string> | Yes | Pos Legacy IDs / Codes |
| dateTo | body | DateTime? | No | Date To |
| dateFrom | body | DateTime? | No | Date From |
| articleCodes | body | List<string> | No | Item Article Codes, both Global and Local |
| productCategories | body | List<ProductCategory> | No | Product Categories |
| saleRepresentativeEmails | body | List<string> | No | Sale Representative Email |
| selloutType | body | string | No | Sellout Type: 'sellout' for sales, 'return' for returns, null for both |
| type | body | string | No | Type: 'consigned' or 'standard', null for both |
| warrantyExtensionStatusIds | body | List<int> | No | Possible warranty extention status IDs, 1 (Activated), 2 (Requested), 3 (Refused), 4 (Error) |
| downloadRequestId | body | string | Yes | Export Request ID of the API Consumers |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| brandCategoryId | form | string | No | Brand Category ID |
| grandCategoryId | form | string | Yes | Grand Category ID |
| masterCategoryId | form | string | No | Master Category ID |
| categoryId | form | string | No | Category ID |
| subCategoryId | form | string | No | Sub Category ID |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| asyncTaskId | form | Guid | Yes | Unique Identifier of the Export Request created |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /warranty/{brand}/export HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
brand: String,
posCodes:
[
String
],
dateTo: 0001-01-01,
dateFrom: 0001-01-01,
articleCodes:
[
String
],
productCategories:
[
{
brandCategoryId: String,
grandCategoryId: String,
masterCategoryId: String,
categoryId: String,
subCategoryId: String
}
],
saleRepresentativeEmails:
[
String
],
selloutType: String,
type: String,
warrantyExtensionStatusIds:
[
0
],
downloadRequestId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
asyncTaskId: 00000000000000000000000000000000
}