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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	emailAddress: String,
	posId: 0,
	brandTrigram: String,
	phoneNumber: String,
	prefixCountryId: String,
	countryId: String,
	sid: String,
	app: String,
	_os: String,
	_appVersion: String,
	_searchMethod: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	customerType: String,
	customerRef: String,
	title: 0,
	titleDs: String,
	firstName: String,
	lastName: String,
	firstNameNotLatin: String,
	lastNameNotLatin: String,
	birthday: String,
	birthDayEventId: 00000000000000000000000000000000,
	weddingDate: String,
	canBeContacted: False,
	seller: 00000000000000000000000000000000,
	language: String,
	languageDs: String,
	nameSuffix: String,
	gender: String,
	companyName: String,
	middleName: String,
	customerId: 00000000000000000000000000000000,
	personId: 00000000000000000000000000000000,
	boosterCustomerId: 0,
	posOwnerId: 0,
	brandOwnerId: String,
	businessUnitId: 0,
	sapGenderId: String,
	allowStoreDataAbroad: False,
	privacyPolicyAcceptanceStorage: False,
	tvAllowStoreDataAbroad: False,
	tvPrivacyPolicyAcceptanceStorage: False,
	contactByMail: False,
	contactByEmail: False,
	contactByPhone: False,
	contactBySMS: False,
	contactBySocialMedia: False,
	addresses: 
	[
		{
			addressId: 00000000000000000000000000000000,
			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: False,
			isMainAddress: False
		}
	],
	emails: 
	[
		{
			emailId: 00000000000000000000000000000000,
			description: String,
			email: String,
			isMainEmail: False,
			type: 
			{
				Id: ,
				Description: String
			}
		}
	],
	phones: 
	[
		{
			phoneId: 00000000000000000000000000000000,
			description: String,
			phone: String,
			isMainPhone: False,
			prefixCountryId: String,
			telephonePrefix: String,
			type: 
			{
				Id: 0,
				Description: String
			}
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	_xmlns: String,
	_type: String,
	_source: String,
	_tstamp: String,
	_user: String,
	_env: String,
	_uri: String,
	_query: String
}