Richemont.Booster2.PublicApi

ExportCustomer

The following routes are available for this service:
POST	/customer/{brand}/export	Export Customer Data

**ExportCustomer** Parameters:
Name	Parameter	Data Type	Required	Description
downloadRequestId	body	string	Yes	Export Request ID of the API Consumers

**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

**ExportCustomerResponse** Parameters:
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 .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.

POST /customer/{brand}/export HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ExportCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.CRM.ServiceModel">
  <birthdateMonths xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </birthdateMonths>
  <boosterCustomerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </boosterCustomerIds>
  <brand>String</brand>
  <canBeContactedByMaison>false</canBeContactedByMaison>
  <clientSpendingFrom>0</clientSpendingFrom>
  <clientSpendingTo>0</clientSpendingTo>
  <creationDateFrom>0001-01-01T00:00:00</creationDateFrom>
  <creationDateTo>0001-01-01T00:00:00</creationDateTo>
  <customerStatus xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </customerStatus>
  <email>String</email>
  <hasSapCrmError>false</hasSapCrmError>
  <hobbies>
    <GetCustomerHobby>
      <hobby>String</hobby>
      <sapHobbyId>String</sapHobbyId>
    </GetCustomerHobby>
  </hobbies>
  <interests>
    <GetCustomerInterest>
      <interest>String</interest>
      <sapInterestId>String</sapInterestId>
    </GetCustomerInterest>
  </interests>
  <locationCountryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </locationCountryIds>
  <phoneNumber>String</phoneNumber>
  <posCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </posCodes>
  <productCategories xmlns:d2p1="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Common.ServiceModel">
    <d2p1:ProductCategory>
      <d2p1:brandCategoryId>String</d2p1:brandCategoryId>
      <d2p1:categoryId>String</d2p1:categoryId>
      <d2p1:grandCategoryId>String</d2p1:grandCategoryId>
      <d2p1:masterCategoryId>String</d2p1:masterCategoryId>
      <d2p1:subCategoryId>String</d2p1:subCategoryId>
    </d2p1:ProductCategory>
  </productCategories>
  <productCollections>
    <GetCustomerProductCollection>
      <productCollection>String</productCollection>
      <sapProductCollectionId>String</sapProductCollectionId>
    </GetCustomerProductCollection>
  </productCollections>
  <saleRepresentativeEmails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </saleRepresentativeEmails>
  <searchKey>String</searchKey>
  <transactionDateFrom>0001-01-01T00:00:00</transactionDateFrom>
  <transactionDateTo>0001-01-01T00:00:00</transactionDateTo>
  <downloadRequestId>String</downloadRequestId>
</ExportCustomer>

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

<ExportCustomerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.CRM.ServiceModel">
  <asyncTaskId>00000000-0000-0000-0000-000000000000</asyncTaskId>
</ExportCustomerResponse>