Richemont.Booster2.PublicApi

<back to all web services

GetCustomer

Requires Authentication
The following routes are available for this service:
GET/customer/{boosterCustomerId}Get customer detailsGet Customer info based on the Booster Customer ID
"use strict";
export class CustomerEmail {
    /** @param {{description?:string,email?:string,isMain?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Description */
    description;
    /**
     * @type {string}
     * @description Email Address */
    email;
    /**
     * @type {boolean}
     * @description Is main email address */
    isMain;
}
export class CustomerPhone {
    /** @param {{description?:string,phone?:string,isMain?:boolean,prefixCountryId?:string,telephonePrefix?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Description */
    description;
    /**
     * @type {string}
     * @description Phone Number */
    phone;
    /**
     * @type {boolean}
     * @description Is main phone number  */
    isMain;
    /**
     * @type {string}
     * @description Phone number country prefix */
    prefixCountryId;
    /**
     * @type {string}
     * @description Telephone prefix */
    telephonePrefix;
}
export class CustomerEvent {
    /** @param {{eventId?:number,eventDescription?:string,eventTypeOther?:string,comment?:string,eventDay?:number,eventMonth?:number,eventYear?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Event Id */
    eventId;
    /**
     * @type {string}
     * @description Event Description  */
    eventDescription;
    /**
     * @type {string}
     * @description Event Other */
    eventTypeOther;
    /**
     * @type {string}
     * @description Comment */
    comment;
    /**
     * @type {number}
     * @description Event Day */
    eventDay;
    /**
     * @type {number}
     * @description Event Month */
    eventMonth;
    /**
     * @type {number}
     * @description Event Year */
    eventYear;
}
export class GetCustomerResponse {
    /** @param {{id?:number,sapId?:string,customerReference?:string,gender?:string,personalTitle?:string,firstName?:string,lastName?:string,firstNameNotLatin?:string,lastNameNotLatin?:string,middleName?:string,canBeContacted?:boolean,language?:string,countryId?:string,brand?:string,emails?:CustomerEmail[],phones?:CustomerPhone[],events?:CustomerEvent[],registrationDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Booster Customer ID */
    id;
    /**
     * @type {string}
     * @description SAP Customer ID */
    sapId;
    /**
     * @type {string}
     * @description Customer Reference */
    customerReference;
    /**
     * @type {string}
     * @description Gender */
    gender;
    /**
     * @type {string}
     * @description Personal Title */
    personalTitle;
    /**
     * @type {string}
     * @description First Name */
    firstName;
    /**
     * @type {string}
     * @description Customer Last Name */
    lastName;
    /**
     * @type {string}
     * @description First Name Not Latin */
    firstNameNotLatin;
    /**
     * @type {string}
     * @description Customer Last Name Not Latin */
    lastNameNotLatin;
    /**
     * @type {string}
     * @description Middle Name */
    middleName;
    /**
     * @type {boolean}
     * @description Can be contacted or not? */
    canBeContacted;
    /**
     * @type {string}
     * @description Language */
    language;
    /**
     * @type {string}
     * @description Country */
    countryId;
    /**
     * @type {string}
     * @description Brand Trigram */
    brand;
    /**
     * @type {CustomerEmail[]}
     * @description List of Emails */
    emails;
    /**
     * @type {CustomerPhone[]}
     * @description List of Phone Numbers */
    phones;
    /**
     * @type {CustomerEvent[]}
     * @description List of Events */
    events;
    /**
     * @type {?string}
     * @description Registration date */
    registrationDate;
}
export class GetCustomer {
    /** @param {{boosterCustomerId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Booster Customer ID */
    boosterCustomerId;
}

JavaScript GetCustomer DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /customer/{boosterCustomerId} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"id":0,"sapId":"String","customerReference":"String","gender":"String","personalTitle":"String","firstName":"String","lastName":"String","firstNameNotLatin":"String","lastNameNotLatin":"String","middleName":"String","canBeContacted":false,"language":"String","countryId":"String","brand":"String","emails":[{"description":"String","email":"String","isMain":false}],"phones":[{"description":"String","phone":"String","isMain":false,"prefixCountryId":"String","telephonePrefix":"String"}],"events":[{"eventId":0,"eventDescription":"String","eventTypeOther":"String","comment":"String","eventDay":0,"eventMonth":0,"eventYear":0}],"registrationDate":"\/Date(-62135596800000-0000)\/"}