POST | /customer | Create customer | Create CRM customer |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
privacyPolicyAcceptanceStorage | body | bool | Yes | Privacy policy acceptance for data storage |
tvPrivacyPolicyAcceptanceStorage | body | bool? | No | Privacy policy acceptance of data storage for TimeVallée |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
title | form | string | No | Title e.g. 'Mr & Mrs', 'Mr.', 'Mrs.', 'Sama', 'Captain' - Mandatory only when customer type is 'PRIVATE' |
firstName | form | string | No | First Name |
lastName | form | string | No | Last Name - Mandatory only when customer type is 'PRIVATE' |
firstNameNotLatin | form | string | No | First Name Not Latin |
lastNameNotLatin | form | string | No | Last Name Not Latin |
middleName | form | string | No | Middle Name |
nameSuffix | form | string | No | Name Suffix |
canBeContactedByMaison | form | bool | Yes | Can be Contacted by Maison e.g. true or false |
clientType | form | string | Yes | Customer Type e.g. 'PRIVATE' or 'COMPANY' |
companyName | form | string | No | Company Name - Mandatory only when customer type is 'COMPANY' |
languageId | form | string | No | Language Id e.g. ita, chi, aze, eng, ger - Mandatory only when customer type is 'PRIVATE' |
gender | form | string | No | Gender e.g. M, F - Mandatory only when customer type is 'PRIVATE' |
countryId | form | string | Yes | Country Id e.g. it, cn, az, gb, de |
birthDate | form | DateTime? | No | Birth Date e.g. '2020-12-30' |
customerReference | form | string | No | Customer reference |
posCode | form | string | Yes | POS Code e.g. ES100:102048 |
brand | form | string | Yes | Brand e.g. CAR, MTB |
weddingDate | form | DateTime? | No | Wedding Date, e.g. '2020-01-18' |
preferredContactMethod | form | string | No | Preferred Contact Method e.g. 'Fax', 'Tel', 'EMail', 'Mail', 'Survey' |
contactByEmailFlag | form | bool | No | Provide 'true' if you want to be contacted by email. Leave empty or 'false' if you do not. |
contactByMailFlag | form | bool | No | Provide 'true' if you want to be contacted by mail. Leave empty or 'false' if you do not. |
contactByPhoneFlag | form | bool | No | Provide 'true' if you want to be contacted by phone. Leave empty or 'false' if you do not. |
contactBySMSFlag | form | bool | No | Provide 'true' if you want to be contacted by SMS. Leave empty or 'false' if you do not. |
contactBySocialMediaFlag | form | bool | No | Provide 'true' if you want to be contacted by social media. Leave empty or 'false' if you do not. |
saleRepresentativeEmail | form | string | No | Sale Representative Email e.g. rauf.aliyev@richemont.com |
allowStoreDataAbroad | form | bool? | No | Consent for allowing Cross Border Data Transfer |
tvAllowStoreDataAbroad | form | bool? | No | Consent for allowing Cross Border Data Transfer For TimeVallée |
emails | form | List<Email> | No | Customer emails |
phones | form | List<Phone> | No | Customer phones |
addresses | form | List<Address> | No | Customer addresses |
events | form | List<Event> | No | Customer events |
interests | form | List<Interest> | No | Customer interests |
hobbies | form | List<Hobby> | No | Customer hobbies |
productCollections | form | List<ProductCollection> | No | Customer product collections |
dataSharingConsent | form | bool? | No | Provide 'true' if you allow data sharing consent. Leave empty or 'false' if you do not. |
notes | form | string | No | Notes |
referenceSaleRepresentativeEmail | form | string | No | Reference Sale Representative Email |
registrationDate | form | DateTime? | No | Registration Date |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
form | string | Yes | ||
isMainEmail | form | bool | Yes | Main email |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
phone | form | string | Yes | Phone e.g. cn: 13888889999, jp: 352858088, kr: 023123456 |
countryPrefix | form | string | Yes | Prefix Country Id e.g. it, fr, az |
phoneType | form | string | No | Phone type e.g. 'Home', 'Mobile', 'Work', 'Other', 'Secondary Address' |
isMainPhone | form | bool | Yes | Main Phone |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
addressType | form | string | Yes | Address type e.g. Home, Office, Shipping |
countryId | form | string | Yes | Country Id e.g. it, cn, az, gb, de |
houseNumber | form | string | No | House Number |
stateId | form | string | No | Region/State |
city | form | string | No | City Name |
zipCode | form | string | No | Postal Code |
street | form | string | No | Street Name and Number |
street2 | form | string | No | Street 2 |
street3 | form | string | No | Street 3 |
street4 | form | string | No | Street 4 |
street5 | form | string | No | Street 5 |
isMainAddress | form | bool | Yes | Main Address |
poBox | form | string | No | Post Office Box |
additionalInformation | form | string | No | Additional Information |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
eventType | form | string | Yes | Event type e.g. 'Birthday', 'Wedding', 'Anniversary', 'Barmitza', 'Other' |
eventDate | form | DateTime | Yes | Event date e.g. '2021-01-20' |
eventNotes | form | string | No | Event notes |
eventOtherName | form | string | No | Event other name |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
interest | form | string | Yes | Interest description |
sapInterestId | form | string | Yes | SAP Interest ID, e.g. 'CA-1' |
translation | form | string | No | Interest description translation |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
hobby | form | string | Yes | Hobby description |
sapHobbyId | form | string | Yes | SAP Hobby ID, e.g. 'ART' |
translation | form | string | No | Hobby description translation |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
productCollection | form | string | Yes | Product Collection description |
sapProductCollectionId | form | string | Yes | SAP ProductCollection ID, e.g. 'CA-1' |
translation | form | string | Yes | Product Collection description translation |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
boosterCustomerId | form | int | Yes | Booster Customer ID |
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 /customer HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"privacyPolicyAcceptanceStorage":false,"tvPrivacyPolicyAcceptanceStorage":false,"title":"String","firstName":"String","lastName":"String","firstNameNotLatin":"String","lastNameNotLatin":"String","middleName":"String","nameSuffix":"String","canBeContactedByMaison":false,"clientType":"String","companyName":"String","languageId":"String","gender":"String","countryId":"String","birthDate":"\/Date(-62135596800000-0000)\/","customerReference":"String","posCode":"String","brand":"String","weddingDate":"\/Date(-62135596800000-0000)\/","preferredContactMethod":"String","contactByEmailFlag":false,"contactByMailFlag":false,"contactByPhoneFlag":false,"contactBySMSFlag":false,"contactBySocialMediaFlag":false,"saleRepresentativeEmail":"String","allowStoreDataAbroad":false,"tvAllowStoreDataAbroad":false,"emails":[{"email":"String","isMainEmail":false}],"phones":[{"phone":"String","countryPrefix":"String","phoneType":"String","isMainPhone":false}],"addresses":[{"addressType":"String","countryId":"String","houseNumber":"String","stateId":"String","city":"String","zipCode":"String","street":"String","street2":"String","street3":"String","street4":"String","street5":"String","isMainAddress":false,"poBox":"String","additionalInformation":"String"}],"events":[{"eventType":"String","eventDate":"\/Date(-62135596800000-0000)\/","eventNotes":"String","eventOtherName":"String"}],"interests":[{"interest":"String","sapInterestId":"String","translation":"String"}],"hobbies":[{"hobby":"String","sapHobbyId":"String","translation":"String"}],"productCollections":[{"productCollection":"String","sapProductCollectionId":"String","translation":"String"}],"dataSharingConsent":false,"notes":"String","referenceSaleRepresentativeEmail":"String","registrationDate":"\/Date(-62135596800000-0000)\/"}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"boosterCustomerId":0}