Booster.Microservices

<back to all web services

GetCustomerSuggestion

Requires Authentication
The following routes are available for this service:
POST/warranty/v1/GetCustomerSuggestion
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseRequest(Generic[TResponse], IRequest):
    sid: Optional[str] = None
    app: Optional[str] = None
    _os: Optional[str] = None
    _app_version: Optional[str] = None
    _search_method: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse(IRespose):
    _xmlns: Optional[str] = None
    _type: Optional[str] = None
    _source: Optional[str] = None
    _tstamp: Optional[str] = None
    _user: Optional[str] = None
    _env: Optional[str] = None
    _uri: Optional[str] = None
    _query: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerAddress:
    address_id: Optional[str] = None
    description: Optional[str] = None
    address_line1: Optional[str] = None
    address_line2: Optional[str] = None
    address_line3: Optional[str] = None
    address_line4: Optional[str] = None
    address_line5: Optional[str] = None
    house_number: Optional[str] = None
    city: Optional[str] = None
    region: Optional[str] = None
    county: Optional[str] = None
    state_or_province_id: Optional[str] = None
    country_id: Optional[str] = None
    country_ds: Optional[str] = None
    zip_code: Optional[str] = None
    address_type_id: Optional[str] = None
    is_mailing_address: bool = False
    is_main_address: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerEmail:
    email_id: Optional[str] = None
    description: Optional[str] = None
    email: Optional[str] = None
    is_main_email: bool = False
    type: Optional[Lookup[str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerPhone:
    phone_id: Optional[str] = None
    description: Optional[str] = None
    phone: Optional[str] = None
    is_main_phone: bool = False
    prefix_country_id: Optional[str] = None
    telephone_prefix: Optional[str] = None
    type: Optional[Lookup[int]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCustomerSuggestionResponse(BaseResponse):
    customer_type: Optional[str] = None
    customer_ref: Optional[str] = None
    title: Optional[int] = None
    title_ds: Optional[str] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    first_name_not_latin: Optional[str] = None
    last_name_not_latin: Optional[str] = None
    birthday: Optional[str] = None
    birth_day_event_id: Optional[str] = None
    wedding_date: Optional[str] = None
    can_be_contacted: Optional[bool] = None
    seller: Optional[str] = None
    language: Optional[str] = None
    language_ds: Optional[str] = None
    name_suffix: Optional[str] = None
    gender: Optional[str] = None
    company_name: Optional[str] = None
    middle_name: Optional[str] = None
    customer_id: Optional[str] = None
    person_id: Optional[str] = None
    booster_customer_id: Optional[int] = None
    pos_owner_id: Optional[int] = None
    brand_owner_id: Optional[str] = None
    business_unit_id: Optional[int] = None
    sap_gender_id: Optional[str] = None
    allow_store_data_abroad: Optional[bool] = None
    privacy_policy_acceptance_storage: Optional[bool] = None
    tv_allow_store_data_abroad: Optional[bool] = None
    tv_privacy_policy_acceptance_storage: Optional[bool] = None
    contact_by_mail: Optional[bool] = None
    contact_by_email: Optional[bool] = None
    contact_by_phone: Optional[bool] = None
    contact_by_s_m_s: Optional[bool] = None
    contact_by_social_media: Optional[bool] = None
    addresses: Optional[List[CustomerAddress]] = None
    emails: Optional[List[CustomerEmail]] = None
    phones: Optional[List[CustomerPhone]] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCustomerSuggestion(BaseRequest[GetCustomerSuggestionResponse]):
    email_address: Optional[str] = None
    pos_id: int = 0
    brand_trigram: Optional[str] = None
    phone_number: Optional[str] = None
    prefix_country_id: Optional[str] = None
    country_id: Optional[str] = None


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Lookup(Generic[T]):
    id: Optional[T] = None
    description: Optional[str] = None

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