Booster.Microservices

<back to all web services

GetCustomerSuggestion

Requires Authentication
The following routes are available for this service:
POST/warranty/v1/GetCustomerSuggestion
"use strict";
/** @typedef TResponse {any} */
export class BaseRequest {
    /** @param {{sid?:string,app?:string,_os?:string,_appVersion?:string,_searchMethod?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    sid;
    /** @type {string} */
    app;
    /** @type {string} */
    _os;
    /** @type {string} */
    _appVersion;
    /** @type {string} */
    _searchMethod;
}
export class BaseResponse {
    /** @param {{_xmlns?:string,_type?:string,_source?:string,_tstamp?:string,_user?:string,_env?:string,_uri?:string,_query?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    _xmlns;
    /** @type {string} */
    _type;
    /** @type {string} */
    _source;
    /** @type {string} */
    _tstamp;
    /** @type {string} */
    _user;
    /** @type {string} */
    _env;
    /** @type {string} */
    _uri;
    /** @type {string} */
    _query;
}
export class CustomerAddress {
    /** @param {{addressId?:string,description?:string,addressLine1?:string,addressLine2?:string,addressLine3?:string,addressLine4?:string,addressLine5?:string,houseNumber?:string,city?:string,region?:string,county?:string,stateOrProvinceId?:string,countryId?:string,countryDs?:string,zipCode?:string,addressTypeId?:string,isMailingAddress?:boolean,isMainAddress?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    addressId;
    /** @type {string} */
    description;
    /** @type {string} */
    addressLine1;
    /** @type {string} */
    addressLine2;
    /** @type {string} */
    addressLine3;
    /** @type {string} */
    addressLine4;
    /** @type {string} */
    addressLine5;
    /** @type {string} */
    houseNumber;
    /** @type {string} */
    city;
    /** @type {string} */
    region;
    /** @type {string} */
    county;
    /** @type {string} */
    stateOrProvinceId;
    /** @type {string} */
    countryId;
    /** @type {string} */
    countryDs;
    /** @type {string} */
    zipCode;
    /** @type {string} */
    addressTypeId;
    /** @type {boolean} */
    isMailingAddress;
    /** @type {boolean} */
    isMainAddress;
}
export class CustomerEmail {
    /** @param {{emailId?:string,description?:string,email?:string,isMainEmail?:boolean,type?:Lookup<string>}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    emailId;
    /** @type {string} */
    description;
    /** @type {string} */
    email;
    /** @type {boolean} */
    isMainEmail;
    /** @type {Lookup<string>} */
    type;
}
export class CustomerPhone {
    /** @param {{phoneId?:string,description?:string,phone?:string,isMainPhone?:boolean,prefixCountryId?:string,telephonePrefix?:string,type?:Lookup<number>}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    phoneId;
    /** @type {string} */
    description;
    /** @type {string} */
    phone;
    /** @type {boolean} */
    isMainPhone;
    /** @type {string} */
    prefixCountryId;
    /** @type {string} */
    telephonePrefix;
    /** @type {Lookup<number>} */
    type;
}
export class GetCustomerSuggestionResponse extends BaseResponse {
    /** @param {{customerType?:string,customerRef?:string,title?:number,titleDs?:string,firstName?:string,lastName?:string,firstNameNotLatin?:string,lastNameNotLatin?:string,birthday?:string,birthDayEventId?:string,weddingDate?:string,canBeContacted?:boolean,seller?:string,language?:string,languageDs?:string,nameSuffix?:string,gender?:string,companyName?:string,middleName?:string,customerId?:string,personId?:string,boosterCustomerId?:number,posOwnerId?:number,brandOwnerId?:string,businessUnitId?:number,sapGenderId?:string,allowStoreDataAbroad?:boolean,privacyPolicyAcceptanceStorage?:boolean,tvAllowStoreDataAbroad?:boolean,tvPrivacyPolicyAcceptanceStorage?:boolean,contactByMail?:boolean,contactByEmail?:boolean,contactByPhone?:boolean,contactBySMS?:boolean,contactBySocialMedia?:boolean,addresses?:CustomerAddress[],emails?:CustomerEmail[],phones?:CustomerPhone[],ResponseStatus?:ResponseStatus,_xmlns?:string,_type?:string,_source?:string,_tstamp?:string,_user?:string,_env?:string,_uri?:string,_query?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    customerType;
    /** @type {string} */
    customerRef;
    /** @type {?number} */
    title;
    /** @type {string} */
    titleDs;
    /** @type {string} */
    firstName;
    /** @type {string} */
    lastName;
    /** @type {string} */
    firstNameNotLatin;
    /** @type {string} */
    lastNameNotLatin;
    /** @type {string} */
    birthday;
    /** @type {?string} */
    birthDayEventId;
    /** @type {string} */
    weddingDate;
    /** @type {?boolean} */
    canBeContacted;
    /** @type {?string} */
    seller;
    /** @type {string} */
    language;
    /** @type {string} */
    languageDs;
    /** @type {string} */
    nameSuffix;
    /** @type {string} */
    gender;
    /** @type {string} */
    companyName;
    /** @type {string} */
    middleName;
    /** @type {?string} */
    customerId;
    /** @type {?string} */
    personId;
    /** @type {?number} */
    boosterCustomerId;
    /** @type {?number} */
    posOwnerId;
    /** @type {string} */
    brandOwnerId;
    /** @type {?number} */
    businessUnitId;
    /** @type {string} */
    sapGenderId;
    /** @type {?boolean} */
    allowStoreDataAbroad;
    /** @type {?boolean} */
    privacyPolicyAcceptanceStorage;
    /** @type {?boolean} */
    tvAllowStoreDataAbroad;
    /** @type {?boolean} */
    tvPrivacyPolicyAcceptanceStorage;
    /** @type {?boolean} */
    contactByMail;
    /** @type {?boolean} */
    contactByEmail;
    /** @type {?boolean} */
    contactByPhone;
    /** @type {?boolean} */
    contactBySMS;
    /** @type {?boolean} */
    contactBySocialMedia;
    /** @type {CustomerAddress[]} */
    addresses;
    /** @type {CustomerEmail[]} */
    emails;
    /** @type {CustomerPhone[]} */
    phones;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetCustomerSuggestion extends BaseRequest {
    /** @param {{emailAddress?:string,posId?:number,brandTrigram?:string,phoneNumber?:string,prefixCountryId?:string,countryId?:string,sid?:string,app?:string,_os?:string,_appVersion?:string,_searchMethod?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    emailAddress;
    /** @type {number} */
    posId;
    /** @type {string} */
    brandTrigram;
    /** @type {string} */
    phoneNumber;
    /** @type {string} */
    prefixCountryId;
    /** @type {string} */
    countryId;
}
/** @typedef T {any} */
export class Lookup {
    /** @param {{Id?:T,Description?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {T} */
    Id;
    /** @type {string} */
    Description;
}

JavaScript GetCustomerSuggestion 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 /warranty/v1/GetCustomerSuggestion HTTP/1.1 
Host: qp-microservices-booster.richemont.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetCustomerSuggestion xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Sale">
  <_appVersion xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_appVersion>
  <_os xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_os>
  <_searchMethod xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_searchMethod>
  <app xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</app>
  <sid xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</sid>
  <brandTrigram>String</brandTrigram>
  <countryId>String</countryId>
  <emailAddress>String</emailAddress>
  <phoneNumber>String</phoneNumber>
  <posId>0</posId>
  <prefixCountryId>String</prefixCountryId>
</GetCustomerSuggestion>

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

<GetCustomerSuggestionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Sale">
  <_env xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_env>
  <_query xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_query>
  <_source xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_source>
  <_tstamp xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_tstamp>
  <_type xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_type>
  <_uri xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_uri>
  <_user xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_user>
  <_xmlns xmlns="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">String</_xmlns>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <addresses>
    <CustomerAddress>
      <addressId>00000000-0000-0000-0000-000000000000</addressId>
      <addressLine1>String</addressLine1>
      <addressLine2>String</addressLine2>
      <addressLine3>String</addressLine3>
      <addressLine4>String</addressLine4>
      <addressLine5>String</addressLine5>
      <addressTypeId>String</addressTypeId>
      <city>String</city>
      <countryDs>String</countryDs>
      <countryId>String</countryId>
      <county>String</county>
      <description>String</description>
      <houseNumber>String</houseNumber>
      <isMailingAddress>false</isMailingAddress>
      <isMainAddress>false</isMainAddress>
      <region>String</region>
      <stateOrProvinceId>String</stateOrProvinceId>
      <zipCode>String</zipCode>
    </CustomerAddress>
  </addresses>
  <allowStoreDataAbroad>false</allowStoreDataAbroad>
  <birthDayEventId>00000000-0000-0000-0000-000000000000</birthDayEventId>
  <birthday>String</birthday>
  <boosterCustomerId>0</boosterCustomerId>
  <brandOwnerId>String</brandOwnerId>
  <businessUnitId>0</businessUnitId>
  <canBeContacted>false</canBeContacted>
  <companyName>String</companyName>
  <contactByEmail>false</contactByEmail>
  <contactByMail>false</contactByMail>
  <contactByPhone>false</contactByPhone>
  <contactBySMS>false</contactBySMS>
  <contactBySocialMedia>false</contactBySocialMedia>
  <customerId>00000000-0000-0000-0000-000000000000</customerId>
  <customerRef>String</customerRef>
  <customerType>String</customerType>
  <emails>
    <CustomerEmail>
      <description>String</description>
      <email>String</email>
      <emailId>00000000-0000-0000-0000-000000000000</emailId>
      <isMainEmail>false</isMainEmail>
      <type xmlns:d4p1="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">
        <d4p1:Description>String</d4p1:Description>
        <d4p1:Id>0</d4p1:Id>
      </type>
    </CustomerEmail>
  </emails>
  <firstName>String</firstName>
  <firstNameNotLatin>String</firstNameNotLatin>
  <gender>String</gender>
  <language>String</language>
  <languageDs>String</languageDs>
  <lastName>String</lastName>
  <lastNameNotLatin>String</lastNameNotLatin>
  <middleName>String</middleName>
  <nameSuffix>String</nameSuffix>
  <personId>00000000-0000-0000-0000-000000000000</personId>
  <phones>
    <CustomerPhone>
      <description>String</description>
      <isMainPhone>false</isMainPhone>
      <phone>String</phone>
      <phoneId>00000000-0000-0000-0000-000000000000</phoneId>
      <prefixCountryId>String</prefixCountryId>
      <telephonePrefix>String</telephonePrefix>
      <type xmlns:d4p1="http://schemas.datacontract.org/2004/07/Booster.Microservices.ServiceModel.Common">
        <d4p1:Description>String</d4p1:Description>
        <d4p1:Id>0</d4p1:Id>
      </type>
    </CustomerPhone>
  </phones>
  <posOwnerId>0</posOwnerId>
  <privacyPolicyAcceptanceStorage>false</privacyPolicyAcceptanceStorage>
  <sapGenderId>String</sapGenderId>
  <seller>00000000-0000-0000-0000-000000000000</seller>
  <title>0</title>
  <titleDs>String</titleDs>
  <tvAllowStoreDataAbroad>false</tvAllowStoreDataAbroad>
  <tvPrivacyPolicyAcceptanceStorage>false</tvPrivacyPolicyAcceptanceStorage>
  <weddingDate>String</weddingDate>
</GetCustomerSuggestionResponse>