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 .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
}