| POST | /purchase/{brand}/export | Export Order Data |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| brand | path | string | Yes | Brand Trigram, e.g. CAR, IWC |
| posCodes | body | List<string> | Yes | POS Legacy |
| dateTo | body | DateTime? | No | Date To |
| dateFrom | body | DateTime? | No | Date From |
| status | body | List<string> | No | Possible order statues: B (Backorder), C (Created), D (Draft), I (In transit)N (Pending), P (Shipped), PS (Partially shipped), R (Reserved), X (RP Simulated), Z (Deleted) |
| reasonCode | body | List<string> | No | Reason Code e.g. Y00, Y06 |
| productCategories | body | List<ProductCategory> | No | Product Categories |
| finalShipTo | body | List<string> | No | Final Ship To Pos Codes |
| 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /purchase/{brand}/export HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"brand":"String","posCodes":["String"],"dateTo":"\/Date(-62135596800000-0000)\/","dateFrom":"\/Date(-62135596800000-0000)\/","status":["String"],"reasonCode":["String"],"productCategories":[{"brandCategoryId":"String","grandCategoryId":"String","masterCategoryId":"String","categoryId":"String","subCategoryId":"String"}],"finalShipTo":["String"],"downloadRequestId":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"asyncTaskId":"00000000000000000000000000000000"}