Richemont.Booster2.PublicApi

<back to all web services

GetPurchasablePos

Requires Authentication
The following routes are available for this service:
GET/purchase/posGet a list of authorized pos that can place orders
"use strict";
export class Pos {
    /** @param {{posCode?:string,name?:string,city?:string,address?:string,country?:string,brand?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description POS Code */
    posCode;
    /**
     * @type {string}
     * @description Name of the POS */
    name;
    /**
     * @type {string}
     * @description City of the POS */
    city;
    /**
     * @type {string}
     * @description Address of the POS */
    address;
    /**
     * @type {string}
     * @description Country of the POS */
    country;
    /**
     * @type {string}
     * @description Brand of the POS */
    brand;
}
export class GetPurchasablePosResponse {
    /** @param {{page?:number,items?:number,totalPages?:number,totalResults?:number,elements?:Pos[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Index of the result set returnedr */
    page;
    /**
     * @type {number}
     * @description Size of the result set returned */
    items;
    /**
     * @type {number}
     * @description Total amount of pages / result sets */
    totalPages;
    /**
     * @type {number}
     * @description Total amount of results */
    totalResults;
    /**
     * @type {Pos[]}
     * @description List of Pos */
    elements;
}
export class GetPurchasablePos {
    /** @param {{page?:number,items?:number,noCount?:boolean,sortBy?:string,brand?:string,boosterContextId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Index of the result set returned */
    page;
    /**
     * @type {number}
     * @description Size of the result set returned */
    items;
    /**
     * @type {boolean}
     * @description Omit precise record count - save on performance */
    noCount;
    /**
     * @type {string}
     * @description Sorting expression */
    sortBy;
    /**
     * @type {string}
     * @description Brand Trigram */
    brand;
    /**
     * @type {string}
     * @description Brand Context ID */
    boosterContextId;
}

JavaScript GetPurchasablePos 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 /purchase/pos HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"page":0,"items":0,"totalPages":0,"totalResults":0}