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

export class Pos
{
    /** @description POS Code */
    // @ApiMember(Description="POS Code", IsRequired=true)
    public posCode: string;

    /** @description Name of the POS */
    // @ApiMember(Description="Name of the POS", IsRequired=true)
    public name: string;

    /** @description City of the POS */
    // @ApiMember(Description="City of the POS", IsRequired=true)
    public city: string;

    /** @description Address of the POS */
    // @ApiMember(Description="Address of the POS", IsRequired=true)
    public address: string;

    /** @description Country of the POS */
    // @ApiMember(Description="Country of the POS", IsRequired=true)
    public country: string;

    /** @description Brand of the POS */
    // @ApiMember(Description="Brand of the POS", IsRequired=true)
    public brand: string;

    public constructor(init?: Partial<Pos>) { (Object as any).assign(this, init); }
}

export class GetPurchasablePosResponse
{
    /** @description Index of the result set returnedr */
    // @ApiMember(Description="Index of the result set returnedr", IsRequired=true)
    public page: number;

    /** @description Size of the result set returned */
    // @ApiMember(Description="Size of the result set returned", IsRequired=true)
    public items: number;

    /** @description Total amount of pages / result sets */
    // @ApiMember(Description="Total amount of pages / result sets", IsRequired=true)
    public totalPages: number;

    /** @description Total amount of results */
    // @ApiMember(Description="Total amount of results", IsRequired=true)
    public totalResults: number;

    /** @description List of Pos */
    // @ApiMember(Description="List of Pos", IsRequired=true)
    public elements: Pos[];

    public constructor(init?: Partial<GetPurchasablePosResponse>) { (Object as any).assign(this, init); }
}

export class GetPurchasablePos implements IPagedRequest
{
    /** @description Index of the result set returned */
    // @ApiMember(Description="Index of the result set returned", IsRequired=true)
    public page: number;

    /** @description Size of the result set returned */
    // @ApiMember(Description="Size of the result set returned", IsRequired=true)
    public items: number;

    /** @description Omit precise record count - save on performance */
    // @ApiMember(Description="Omit precise record count - save on performance")
    public noCount: boolean;

    /** @description Sorting expression */
    // @ApiMember(Description="Sorting expression")
    public sortBy: string;

    /** @description Brand Trigram */
    // @ApiMember(Description="Brand Trigram", IsRequired=true)
    public brand: string;

    /** @description Brand Context ID */
    // @ApiMember(Description="Brand Context ID")
    public boosterContextId: string;

    public constructor(init?: Partial<GetPurchasablePos>) { (Object as any).assign(this, init); }
}

TypeScript GetPurchasablePos DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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