Richemont.Booster2.PublicApi

GetCustomerPaginated

The following routes are available for this service:
GET	/customer/{brand}/slim	Get customers list	Get slim list of customers paginated and sorted

**GetCustomerPaginated** Parameters:
Name	Parameter	Data Type	Required	Description
page	query	int	No	Index of the result set returned
items	query	int	No	Size of the result set returned
noCount	query	bool	No	Omit precise record count - save on performance
sortBy	query	string	No	Values can be 'NameDESC', 'NameASC', 'RegASC', 'RegDESC'

**SearchCustomer** Parameters:
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
email	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

**GetCustomerInterest** Parameters:
Name	Parameter	Data Type	Required	Description
interest	form	string	Yes	Interest description
sapInterestId	form	string	Yes	SAP Interest ID, e.g. 'CA-1'

**GetCustomerHobby** Parameters:
Name	Parameter	Data Type	Required	Description
hobby	form	string	No	Hobby description
sapHobbyId	form	string	No	SAP Hobby ID, e.g. 'ART'

**GetCustomerProductCollection** Parameters:
Name	Parameter	Data Type	Required	Description
productCollection	form	string	Yes	Product Collection description
sapProductCollectionId	form	string	Yes	SAP ProductCollection ID, e.g. 'CA-1'

**ProductCategory** Parameters:
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

**GetCustomerPaginatedResponse** Parameters:
Name	Parameter	Data Type	Required	Description
totalPages	form	int	Yes	Total Pages
totalResults	form	int	Yes	Total Results
page	form	int	Yes	Index of the result set returned
items	form	int	Yes	Size of the result set returned
elements	form	IEnumerable<GetCustomerPaginatedElement>	Yes	List of customers

**GetCustomerPaginatedElement** Parameters:
Name	Parameter	Data Type	Required	Description
boosterCustomerId	form	int	Yes	Booster Customer Id
firstName	form	string	Yes	First name
middleName	form	string	Yes	Middle name
lastName	form	string	Yes	Last name
firstNameNotLatin	form	string	Yes	First name Not Latin
lastNameNotLatin	form	string	Yes	Last name Not Latin
phone	form	string	Yes	Customer phone
countryPrefix	form	string	Yes	Phone Country Prefix
email	form	string	Yes	Customer email
dataSharingConsent	form	bool?	Yes	Data Sharing Consent
selloutTransactionCount	form	int	Yes	Sellout Transaction Count
elevateCustomerId	form	string	No	Elevate Customer ID
elevateConsentStatus	form	string	No	Elevate Consent Status
countryId	form	string	No	Customer Country Id
registrationDate	form	DateTime?	No	Registration date
sapCrmErrorMessage	form	string	No	Sap Crm Error Message

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /customer/{brand}/slim HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCustomerPaginatedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.CRM.ServiceModel">
  <elements i:nil="true" />
  <items>0</items>
  <page>0</page>
  <totalPages>0</totalPages>
  <totalResults>0</totalResults>
</GetCustomerPaginatedResponse>