| POST | /customer/{brand}/export | Export Customer Data |
|---|
"use strict";
export class GetCustomerInterest {
/** @param {{interest?:string,sapInterestId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Interest description */
interest;
/**
* @type {string}
* @description SAP Interest ID, e.g. 'CA-1' */
sapInterestId;
}
export class GetCustomerHobby {
/** @param {{hobby?:string,sapHobbyId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Hobby description */
hobby;
/**
* @type {string}
* @description SAP Hobby ID, e.g. 'ART' */
sapHobbyId;
}
export class GetCustomerProductCollection {
/** @param {{productCollection?:string,sapProductCollectionId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Product Collection description */
productCollection;
/**
* @type {string}
* @description SAP ProductCollection ID, e.g. 'CA-1' */
sapProductCollectionId;
}
export class ProductCategory {
/** @param {{brandCategoryId?:string,grandCategoryId?:string,masterCategoryId?:string,categoryId?:string,subCategoryId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Brand Category ID */
brandCategoryId;
/**
* @type {string}
* @description Grand Category ID */
grandCategoryId;
/**
* @type {string}
* @description Master Category ID */
masterCategoryId;
/**
* @type {string}
* @description Category ID */
categoryId;
/**
* @type {string}
* @description Sub Category ID */
subCategoryId;
}
export class SearchCustomer {
/** @param {{brand?:string,posCodes?:string[],searchKey?:string,phoneNumber?:string,email?:string,locationCountryIds?:string[],clientSpendingFrom?:number,clientSpendingTo?:number,creationDateFrom?:string,creationDateTo?:string,transactionDateFrom?:string,transactionDateTo?:string,canBeContactedByMaison?:boolean,birthdateMonths?:number[],interests?:GetCustomerInterest[],hobbies?:GetCustomerHobby[],productCollections?:GetCustomerProductCollection[],customerStatus?:string[],boosterCustomerIds?:number[],hasSapCrmError?:boolean,productCategories?:ProductCategory[],saleRepresentativeEmails?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Brand */
brand;
/**
* @type {string[]}
* @description POS Legacy */
posCodes;
/**
* @type {string}
* @description Search key could be: 'Name', 'Email', 'Phone' without prefix, 'BoosterCustomerId' OR 'SapCRMId' */
searchKey;
/**
* @type {string}
* @description Search by phone number - exact match */
phoneNumber;
/**
* @type {string}
* @description Search by email address - exact match */
email;
/**
* @type {string[]}
* @description Values can be 'it', 'en' etc. */
locationCountryIds;
/**
* @type {?number}
* @description Client Spending From e.g. '100' */
clientSpendingFrom;
/**
* @type {?number}
* @description Client Spending To e.g. '50000' */
clientSpendingTo;
/**
* @type {?string}
* @description Customer Creation Date From e.g. '2022-01-01' */
creationDateFrom;
/**
* @type {?string}
* @description Customer Creation Date To e.g. '2023-11-01' */
creationDateTo;
/**
* @type {?string}
* @description Transaction Date From e.g. '2022-01-01' */
transactionDateFrom;
/**
* @type {?string}
* @description Transaction Date To e.g. '2023-11-01' */
transactionDateTo;
/**
* @type {?boolean}
* @description Values can be 'true' or 'false' */
canBeContactedByMaison;
/**
* @type {number[]}
* @description 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' */
birthdateMonths;
/**
* @type {GetCustomerInterest[]}
* @description Customer interest filter */
interests;
/**
* @type {GetCustomerHobby[]}
* @description Customer hobby filter */
hobbies;
/**
* @type {GetCustomerProductCollection[]}
* @description Customer product collection filter */
productCollections;
/**
* @type {string[]}
* @description Customer Status e.g. 'Prospect', 'Client' */
customerStatus;
/**
* @type {number[]}
* @description List of BoosterCustomerIds, e.g. 1234567,1231231,12323423 */
boosterCustomerIds;
/**
* @type {?boolean}
* @description Values can be 'true' or 'false' */
hasSapCrmError;
/**
* @type {ProductCategory[]}
* @description Product Categories */
productCategories;
/**
* @type {string[]}
* @description Sale Reprentative Emails */
saleRepresentativeEmails;
}
export class ExportCustomerResponse {
/** @param {{asyncTaskId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Unique Identifier of the Export Request created */
asyncTaskId;
}
export class ExportCustomer extends SearchCustomer {
/** @param {{downloadRequestId?:string,brand?:string,posCodes?:string[],searchKey?:string,phoneNumber?:string,email?:string,locationCountryIds?:string[],clientSpendingFrom?:number,clientSpendingTo?:number,creationDateFrom?:string,creationDateTo?:string,transactionDateFrom?:string,transactionDateTo?:string,canBeContactedByMaison?:boolean,birthdateMonths?:number[],interests?:GetCustomerInterest[],hobbies?:GetCustomerHobby[],productCollections?:GetCustomerProductCollection[],customerStatus?:string[],boosterCustomerIds?:number[],hasSapCrmError?:boolean,productCategories?:ProductCategory[],saleRepresentativeEmails?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description Export Request ID of the API Consumers */
downloadRequestId;
}
JavaScript ExportCustomer DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
downloadRequestId: String,
brand: String,
posCodes:
[
String
],
searchKey: String,
phoneNumber: String,
email: String,
locationCountryIds:
[
String
],
clientSpendingFrom: 0,
clientSpendingTo: 0,
creationDateFrom: 0001-01-01,
creationDateTo: 0001-01-01,
transactionDateFrom: 0001-01-01,
transactionDateTo: 0001-01-01,
canBeContactedByMaison: False,
birthdateMonths:
[
0
],
interests:
[
{
interest: String,
sapInterestId: String
}
],
hobbies:
[
{
hobby: String,
sapHobbyId: String
}
],
productCollections:
[
{
productCollection: String,
sapProductCollectionId: String
}
],
customerStatus:
[
String
],
boosterCustomerIds:
[
0
],
hasSapCrmError: False,
productCategories:
[
{
brandCategoryId: String,
grandCategoryId: String,
masterCategoryId: String,
categoryId: String,
subCategoryId: String
}
],
saleRepresentativeEmails:
[
String
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
asyncTaskId: 00000000000000000000000000000000
}