Richemont.Booster2.PublicApi

<back to all web services

GetCustomerV2

Requires Authentication
The following routes are available for this service:
GET/customer/v2/{customerId}Get customer detailsGet Customer info based on the Booster or Elevate Customer ID
GetCustomerV2 Parameters:
NameParameterData TypeRequiredDescription
customerIdpathstringYesBooster or Elevate Customer ID
GetCustomerV2Response Parameters:
NameParameterData TypeRequiredDescription
boosterCustomerIdformint?NoBooster Customer ID
elevateCustomerIdformstringNoElevate Customer ID
sapIdformstringYesSAP ID
titleformstringYesTitle e.g. 'Mr & Mrs', 'Mr.', 'Mrs.', 'Sama', 'Captain' - Mandatory only when customer type is 'Personal'
firstNameformstringYesFirst Name
lastNameformstringYesLast Name - Mandatory only when customer type is 'Personal'
firstNameNotLatinformstringYesFirst Name Not Latin, e.g. Arabic
lastNameNotLatinformstringYesLast Name Not Latin, e.g. Arabic; Mandatory only when customer type is 'Personal'
middleNameformstringNoMiddle Name
nameSuffixformstringNoName Suffix
canBeContactedByMaisonformboolYesCan be Contacted by Maison e.g. true or false
clientTypeformstringYesclientType e.g. Private, Company
companyNameformstringNoCompany Name - Mandatory only when customer type is 'Company'
languageIdformstringNoLanguage Id e.g. ita, chi, aze, eng, ger - Mandatory only when customer type is 'Personal'
genderformstringNoGender e.g. M, F - Mandatory only when customer type is 'Personal'
countryIdformstringYesCountry Id e.g. it, ch, az, gb, de
countryDsformstringYesCountry Description e.g. Italy, Switzerland, Azerbaijan, Great Britain, Germany
birthDateformstringNoBirth Date e.g. '2020-12-30'
customerReferenceformstringNoCustomer reference
posCodeformstringYesPOS Code e.g. ES100:102048
brandformstringYesBrand e.g. CAR, MTB
weddingDateformstringNoWedding Date, e.g. '2020-01-18'
preferredContactMethodformstringNoPreferred Contact Method e.g. 'Fax', 'Tel', 'EMail', 'Mail', 'Survey'
contactByEmailFlagformboolNoProvide 'true' if you want to be contacted by email. Leave empty or 'false' if you do not.
contactByMailFlagformboolNoProvide 'true' if you want to be contacted by mail. Leave empty or 'false' if you do not.
contactByPhoneFlagformboolNoProvide 'true' if you want to be contacted by phone. Leave empty or 'false' if you do not.
contactBySMSFlagformboolNoProvide 'true' if you want to be contacted by SMS. Leave empty or 'false' if you do not.
contactBySocialMediaFlagformboolNoProvide 'true' if you want to be contacted by social media. Leave empty or 'false' if you do not.
saleRepresentativeEmailformstringNoSale Representative Email e.g. rauf.aliyev@richemont.com
allowStoreDataAbroadformbool?NoConsent for allowing Cross Border Data Transfer
dataSharingConsentformbool?NoProvide 'true' if you allow data sharing consent. Leave empty or 'false' if you do not.
dataSharingConsentTimestampformstringNoData Sharing Consent Timestamp
clientRegistrationDateformstringNoClient Registration Date
createdOnformstringNoClient Creation Date
notesformstringNoNotes
emailsformList<Email>NoCustomer emails
phonesformList<Phone>NoCustomer phones
addressesformList<Address>NoCustomer addresses
eventsformList<CustomerEventV2>NoCustomer events
interestsformList<Interest>NoCustomer interests
hobbiesformList<Hobby>NoCustomer hobbies
productCollectionsformList<ProductCollection>NoCustomer Product Collections
registrationDateformDateTime?NoRegistration date
sapCrmErrorMessageformstringNoSap Crm Error Message
Email Parameters:
NameParameterData TypeRequiredDescription
emailformstringYesEmail
isMainEmailformboolYesMain email
Phone Parameters:
NameParameterData TypeRequiredDescription
phoneformstringYesPhone e.g. cn: 13888889999, jp: 352858088, kr: 023123456
countryPrefixformstringYesPrefix Country Id e.g. it, fr, az
phoneTypeformstringNoPhone type e.g. 'Home', 'Mobile', 'Work', 'Other', 'Secondary Address'
isMainPhoneformboolYesMain Phone
Address Parameters:
NameParameterData TypeRequiredDescription
addressTypeformstringYesAddress type e.g. Home, Office, Shipping
countryIdformstringYesCountry Id e.g. it, cn, az, gb, de
houseNumberformstringNoHouse Number
stateIdformstringNoRegion/State
cityformstringNoCity Name
zipCodeformstringNoPostal Code
streetformstringNoStreet Name and Number
street2formstringNoStreet 2
street3formstringNoStreet 3
street4formstringNoStreet 4
street5formstringNoStreet 5
isMainAddressformboolYesMain Address
poBoxformstringNoPost Office Box
additionalInformationformstringNoAdditional Information
CustomerEventV2 Parameters:
NameParameterData TypeRequiredDescription
eventTypeformstringYesEvent type e.g. 'Birthday', 'Wedding', 'Anniversary', 'Barmitza', 'Other'
eventDateformstringYesEvent date e.g. '2021-01-20'
eventNotesformstringNoEvent notes
eventOtherNameformstringNoEvent other name
Interest Parameters:
NameParameterData TypeRequiredDescription
interestformstringYesInterest description
sapInterestIdformstringYesSAP Interest ID, e.g. 'CA-1'
translationformstringNoInterest description translation
Hobby Parameters:
NameParameterData TypeRequiredDescription
hobbyformstringYesHobby description
sapHobbyIdformstringYesSAP Hobby ID, e.g. 'ART'
translationformstringNoHobby description translation
ProductCollection Parameters:
NameParameterData TypeRequiredDescription
productCollectionformstringYesProduct Collection description
sapProductCollectionIdformstringYesSAP ProductCollection ID, e.g. 'CA-1'
translationformstringYesProduct Collection description translation

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

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"boosterCustomerId":0,"elevateCustomerId":"String","sapId":"String","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","countryDs":"String","birthDate":"String","customerReference":"String","posCode":"String","brand":"String","weddingDate":"String","preferredContactMethod":"String","contactByEmailFlag":false,"contactByMailFlag":false,"contactByPhoneFlag":false,"contactBySMSFlag":false,"contactBySocialMediaFlag":false,"saleRepresentativeEmail":"String","allowStoreDataAbroad":false,"dataSharingConsent":false,"dataSharingConsentTimestamp":"String","clientRegistrationDate":"String","createdOn":"String","notes":"String","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":"String","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"}],"registrationDate":"\/Date(-62135596800000-0000)\/","sapCrmErrorMessage":"String"}