| GET | /customer/v2/{customerId} | Get customer details | Get Customer info based on the Booster or Elevate Customer ID |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| customerId | path | string | Yes | Booster or Elevate Customer ID |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| boosterCustomerId | form | int? | No | Booster Customer ID |
| elevateCustomerId | form | string | No | Elevate Customer ID |
| sapId | form | string | Yes | SAP ID |
| title | form | string | Yes | Title e.g. 'Mr & Mrs', 'Mr.', 'Mrs.', 'Sama', 'Captain' - Mandatory only when customer type is 'Personal' |
| firstName | form | string | Yes | First Name |
| lastName | form | string | Yes | Last Name - Mandatory only when customer type is 'Personal' |
| firstNameNotLatin | form | string | Yes | First Name Not Latin, e.g. Arabic |
| lastNameNotLatin | form | string | Yes | Last Name Not Latin, e.g. Arabic; Mandatory only when customer type is 'Personal' |
| 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 | clientType e.g. Private, 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 'Personal' |
| gender | form | string | No | Gender e.g. M, F - Mandatory only when customer type is 'Personal' |
| countryId | form | string | Yes | Country Id e.g. it, ch, az, gb, de |
| countryDs | form | string | Yes | Country Description e.g. Italy, Switzerland, Azerbaijan, Great Britain, Germany |
| birthDate | form | string | 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 | string | 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 |
| dataSharingConsent | form | bool? | No | Provide 'true' if you allow data sharing consent. Leave empty or 'false' if you do not. |
| dataSharingConsentTimestamp | form | string | No | Data Sharing Consent Timestamp |
| clientRegistrationDate | form | string | No | Client Registration Date |
| createdOn | form | string | No | Client Creation Date |
| notes | form | string | No | Notes |
| emails | form | List<Email> | No | Customer emails |
| phones | form | List<Phone> | No | Customer phones |
| addresses | form | List<Address> | No | Customer addresses |
| events | form | List<CustomerEventV2> | 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 |
| registrationDate | form | DateTime? | No | Registration date |
| sapCrmErrorMessage | form | string | No | Sap Crm Error Message |
| 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 | string | 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 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /customer/v2/{customerId} HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetCustomerV2Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.CRM.ServiceModel">
<addresses>
<Address>
<additionalInformation>String</additionalInformation>
<addressType>String</addressType>
<city>String</city>
<countryId>String</countryId>
<houseNumber>String</houseNumber>
<isMainAddress>false</isMainAddress>
<poBox>String</poBox>
<stateId>String</stateId>
<street>String</street>
<street2>String</street2>
<street3>String</street3>
<street4>String</street4>
<street5>String</street5>
<zipCode>String</zipCode>
</Address>
</addresses>
<allowStoreDataAbroad>false</allowStoreDataAbroad>
<birthDate>String</birthDate>
<boosterCustomerId>0</boosterCustomerId>
<brand>String</brand>
<canBeContactedByMaison>false</canBeContactedByMaison>
<clientRegistrationDate>String</clientRegistrationDate>
<clientType>String</clientType>
<companyName>String</companyName>
<contactByEmailFlag>false</contactByEmailFlag>
<contactByMailFlag>false</contactByMailFlag>
<contactByPhoneFlag>false</contactByPhoneFlag>
<contactBySMSFlag>false</contactBySMSFlag>
<contactBySocialMediaFlag>false</contactBySocialMediaFlag>
<countryDs>String</countryDs>
<countryId>String</countryId>
<createdOn>String</createdOn>
<customerReference>String</customerReference>
<dataSharingConsent>false</dataSharingConsent>
<dataSharingConsentTimestamp>String</dataSharingConsentTimestamp>
<elevateCustomerId>String</elevateCustomerId>
<emails>
<Email>
<email>String</email>
<isMainEmail>false</isMainEmail>
</Email>
</emails>
<events>
<CustomerEventV2>
<eventDate>String</eventDate>
<eventNotes>String</eventNotes>
<eventOtherName>String</eventOtherName>
<eventType>String</eventType>
</CustomerEventV2>
</events>
<firstName>String</firstName>
<firstNameNotLatin>String</firstNameNotLatin>
<gender>String</gender>
<hobbies>
<Hobby>
<hobby>String</hobby>
<sapHobbyId>String</sapHobbyId>
<translation>String</translation>
</Hobby>
</hobbies>
<interests>
<Interest>
<interest>String</interest>
<sapInterestId>String</sapInterestId>
<translation>String</translation>
</Interest>
</interests>
<languageId>String</languageId>
<lastName>String</lastName>
<lastNameNotLatin>String</lastNameNotLatin>
<middleName>String</middleName>
<nameSuffix>String</nameSuffix>
<notes>String</notes>
<phones>
<Phone>
<countryPrefix>String</countryPrefix>
<isMainPhone>false</isMainPhone>
<phone>String</phone>
<phoneType>String</phoneType>
</Phone>
</phones>
<posCode>String</posCode>
<preferredContactMethod>String</preferredContactMethod>
<productCollections>
<ProductCollection>
<productCollection>String</productCollection>
<sapProductCollectionId>String</sapProductCollectionId>
<translation>String</translation>
</ProductCollection>
</productCollections>
<registrationDate>0001-01-01T00:00:00</registrationDate>
<saleRepresentativeEmail>String</saleRepresentativeEmail>
<sapCrmErrorMessage>String</sapCrmErrorMessage>
<sapId>String</sapId>
<title>String</title>
<weddingDate>String</weddingDate>
</GetCustomerV2Response>