| POST | /customer/{brand}/export | Export Customer Data |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| downloadRequestId | body | string | Yes | Export Request ID of the API Consumers |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| brand | form | string | Yes | Brand |
| posCodes | form | List<string> | Yes | POS Legacy |
| searchKey | form | string | No | Search key could be: 'Name', 'Email', 'Phone' without prefix, 'BoosterCustomerId' OR 'SapCRMId' |
| phoneNumber | form | string | No | Search by phone number - exact match |
| form | string | No | Search by email address - exact match | |
| locationCountryIds | form | List<string> | No | Values can be 'it', 'en' etc. |
| clientSpendingFrom | form | double? | No | Client Spending From e.g. '100' |
| clientSpendingTo | form | double? | No | Client Spending To e.g. '50000' |
| creationDateFrom | form | DateTime? | No | Customer Creation Date From e.g. '2022-01-01' |
| creationDateTo | form | DateTime? | No | Customer Creation Date To e.g. '2023-11-01' |
| transactionDateFrom | form | DateTime? | No | Transaction Date From e.g. '2022-01-01' |
| transactionDateTo | form | DateTime? | No | Transaction Date To e.g. '2023-11-01' |
| canBeContactedByMaison | form | bool? | No | Values can be 'true' or 'false' |
| birthdateMonths | form | List<int> | No | Values can be 1 for 'January', 2 for 'February', 3 for 'March', 4 for 'April', 5 for 'May', 6 for 'June', 7 for 'July', 8 for 'August', 9 for 'September', 10 for 'October', 11 for 'November', 12 for 'December' |
| interests | form | List<GetCustomerInterest> | No | Customer interest filter |
| hobbies | form | List<GetCustomerHobby> | No | Customer hobby filter |
| productCollections | form | List<GetCustomerProductCollection> | No | Customer product collection filter |
| customerStatus | form | List<string> | No | Customer Status e.g. 'Prospect', 'Client' |
| boosterCustomerIds | form | List<int> | No | List of BoosterCustomerIds, e.g. 1234567,1231231,12323423 |
| hasSapCrmError | form | bool? | No | Values can be 'true' or 'false' |
| productCategories | form | List<ProductCategory> | No | Product Categories |
| saleRepresentativeEmails | form | List<string> | No | Sale Reprentative Emails |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| interest | form | string | Yes | Interest description |
| sapInterestId | form | string | Yes | SAP Interest ID, e.g. 'CA-1' |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| hobby | form | string | No | Hobby description |
| sapHobbyId | form | string | No | SAP Hobby ID, e.g. 'ART' |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| productCollection | form | string | Yes | Product Collection description |
| sapProductCollectionId | form | string | Yes | SAP ProductCollection ID, e.g. 'CA-1' |
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /customer/{brand}/export HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"downloadRequestId":"String","brand":"String","posCodes":["String"],"searchKey":"String","phoneNumber":"String","email":"String","locationCountryIds":["String"],"clientSpendingFrom":0,"clientSpendingTo":0,"creationDateFrom":"\/Date(-62135596800000-0000)\/","creationDateTo":"\/Date(-62135596800000-0000)\/","transactionDateFrom":"\/Date(-62135596800000-0000)\/","transactionDateTo":"\/Date(-62135596800000-0000)\/","canBeContactedByMaison":false,"birthdateMonths":[0],"interests":[{"interest":"String","sapInterestId":"String"}],"hobbies":[{"hobby":"String","sapHobbyId":"String"}],"productCollections":[{"productCollection":"String","sapProductCollectionId":"String"}],"customerStatus":["String"],"boosterCustomerIds":[0],"hasSapCrmError":false,"productCategories":[{"brandCategoryId":"String","grandCategoryId":"String","masterCategoryId":"String","categoryId":"String","subCategoryId":"String"}],"saleRepresentativeEmails":["String"]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"asyncTaskId":"00000000000000000000000000000000"}