Richemont.Booster2.PublicApi

<back to all web services

ExportCustomer

Requires Authentication
The following routes are available for this service:
POST/customer/{brand}/exportExport Customer Data

export class GetCustomerInterest
{
    /** @description Interest description */
    // @ApiMember(Description="Interest description", IsRequired=true)
    public interest: string;

    /** @description SAP Interest ID, e.g. 'CA-1' */
    // @ApiMember(Description="SAP Interest ID, e.g. 'CA-1'", IsRequired=true)
    public sapInterestId: string;

    public constructor(init?: Partial<GetCustomerInterest>) { (Object as any).assign(this, init); }
}

export class GetCustomerHobby
{
    /** @description Hobby description */
    // @ApiMember(Description="Hobby description")
    public hobby: string;

    /** @description SAP Hobby ID, e.g. 'ART' */
    // @ApiMember(Description="SAP Hobby ID, e.g. 'ART'")
    public sapHobbyId: string;

    public constructor(init?: Partial<GetCustomerHobby>) { (Object as any).assign(this, init); }
}

export class GetCustomerProductCollection
{
    /** @description Product Collection description */
    // @ApiMember(Description="Product Collection description", IsRequired=true)
    public productCollection: string;

    /** @description SAP ProductCollection ID, e.g. 'CA-1' */
    // @ApiMember(Description="SAP ProductCollection ID, e.g. 'CA-1'", IsRequired=true)
    public sapProductCollectionId: string;

    public constructor(init?: Partial<GetCustomerProductCollection>) { (Object as any).assign(this, init); }
}

export class ProductCategory
{
    /** @description Brand Category ID */
    // @ApiMember(Description="Brand Category ID")
    public brandCategoryId: string;

    /** @description Grand Category ID */
    // @ApiMember(Description="Grand Category ID", IsRequired=true)
    public grandCategoryId: string;

    /** @description Master Category ID */
    // @ApiMember(Description="Master Category ID")
    public masterCategoryId: string;

    /** @description Category ID */
    // @ApiMember(Description="Category ID")
    public categoryId: string;

    /** @description Sub Category ID */
    // @ApiMember(Description="Sub Category ID")
    public subCategoryId: string;

    public constructor(init?: Partial<ProductCategory>) { (Object as any).assign(this, init); }
}

export class SearchCustomer
{
    /** @description Brand */
    // @ApiMember(Description="Brand", IsRequired=true)
    public brand: string;

    /** @description POS Legacy */
    // @ApiMember(Description="POS Legacy", IsRequired=true)
    public posCodes: string[];

    /** @description Search key could be: 'Name', 'Email', 'Phone' without prefix, 'BoosterCustomerId' OR 'SapCRMId' */
    // @ApiMember(Description="Search key could be: 'Name', 'Email', 'Phone' without prefix, 'BoosterCustomerId' OR 'SapCRMId'")
    public searchKey: string;

    /** @description Search by phone number - exact match */
    // @ApiMember(Description="Search by phone number - exact match")
    public phoneNumber: string;

    /** @description Search by email address - exact match */
    // @ApiMember(Description="Search by email address - exact match")
    public email: string;

    /** @description Values can be 'it', 'en' etc. */
    // @ApiMember(Description="Values can be 'it', 'en' etc.")
    public locationCountryIds: string[];

    /** @description Client Spending From e.g. '100' */
    // @ApiMember(Description="Client Spending From e.g. '100'")
    public clientSpendingFrom?: number;

    /** @description Client Spending To e.g. '50000' */
    // @ApiMember(Description="Client Spending To e.g. '50000'")
    public clientSpendingTo?: number;

    /** @description Customer Creation Date From e.g. '2022-01-01' */
    // @ApiMember(Description="Customer Creation Date From e.g. '2022-01-01'")
    public creationDateFrom?: string;

    /** @description Customer Creation Date To e.g. '2023-11-01' */
    // @ApiMember(Description="Customer Creation Date To e.g. '2023-11-01'")
    public creationDateTo?: string;

    /** @description Transaction Date From e.g. '2022-01-01' */
    // @ApiMember(Description="Transaction Date From e.g. '2022-01-01'")
    public transactionDateFrom?: string;

    /** @description Transaction Date To e.g. '2023-11-01' */
    // @ApiMember(Description="Transaction Date To e.g. '2023-11-01'")
    public transactionDateTo?: string;

    /** @description Values can be 'true' or 'false' */
    // @ApiMember(Description="Values can be 'true' or 'false'")
    public canBeContactedByMaison?: boolean;

    /** @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' */
    // @ApiMember(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'")
    public birthdateMonths: number[];

    /** @description Customer interest filter */
    // @ApiMember(Description="Customer interest filter")
    public interests: GetCustomerInterest[];

    /** @description Customer hobby filter */
    // @ApiMember(Description="Customer hobby filter")
    public hobbies: GetCustomerHobby[];

    /** @description Customer product collection filter */
    // @ApiMember(Description="Customer product collection filter")
    public productCollections: GetCustomerProductCollection[];

    /** @description Customer Status e.g. 'Prospect', 'Client' */
    // @ApiMember(Description="Customer Status e.g. 'Prospect', 'Client'")
    public customerStatus: string[];

    /** @description List of BoosterCustomerIds, e.g. 1234567,1231231,12323423 */
    // @ApiMember(Description="List of BoosterCustomerIds, e.g. 1234567,1231231,12323423")
    public boosterCustomerIds: number[];

    /** @description Values can be 'true' or 'false' */
    // @ApiMember(Description="Values can be 'true' or 'false'")
    public hasSapCrmError?: boolean;

    /** @description Product Categories */
    // @ApiMember(Description="Product Categories")
    public productCategories: ProductCategory[];

    /** @description Sale Reprentative Emails */
    // @ApiMember(Description="Sale Reprentative Emails")
    public saleRepresentativeEmails: string[];

    public constructor(init?: Partial<SearchCustomer>) { (Object as any).assign(this, init); }
}

export class ExportCustomerResponse
{
    /** @description Unique Identifier of the Export Request created */
    // @ApiMember(Description="Unique Identifier of the Export Request created", IsRequired=true)
    public asyncTaskId: string;

    public constructor(init?: Partial<ExportCustomerResponse>) { (Object as any).assign(this, init); }
}

export class ExportCustomer extends SearchCustomer
{
    /** @description Export Request ID of the API Consumers */
    // @ApiMember(Description="Export Request ID of the API Consumers", IsRequired=true)
    public downloadRequestId: string;

    public constructor(init?: Partial<ExportCustomer>) { super(init); (Object as any).assign(this, init); }
}

TypeScript ExportCustomer DTOs

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>