Richemont.Booster2.PublicApi

<back to all web services

ExportCustomer

"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

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>