Richemont.Booster2.PublicApi

<back to all web services

GetWarehouseStock

Requires Authentication
The following routes are available for this service:
GET/warehouseItems/{brand}/{posCode}Get a list Paginated Warehouse Stock

export class WarehouseStockElement
{
    /** @description Article Code */
    // @ApiMember(Description="Article Code", IsRequired=true)
    public articleCode: string;

    /** @description Current Stock Quantity */
    // @ApiMember(Description="Current Stock Quantity", IsRequired=true)
    public atpQuantity: number;

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

export class GetWarehouseStockResponse
{
    /** @description Total Pages */
    // @ApiMember(Description="Total Pages", IsRequired=true)
    public totalPages: number;

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

    /** @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 List of movements */
    // @ApiMember(Description="List of movements", IsRequired=true)
    public elements: WarehouseStockElement[];

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

export class GetWarehouseStock implements IPagedRequest
{
    /** @description Brand */
    // @ApiMember(Description="Brand", IsRequired=true)
    public brand: string;

    /** @description POS Legacy */
    // @ApiMember(Description="POS Legacy", IsRequired=true)
    public posCode: string;

    /** @description List of Article Codes */
    // @ApiMember(Description="List of Article Codes")
    public articleCodes: string[];

    /** @description Index of the result set returned */
    // @ApiMember(Description="Index of the result set returned")
    public page: number;

    /** @description Size of the result set returned */
    // @ApiMember(Description="Size of the result set returned")
    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;

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

TypeScript GetWarehouseStock 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 /warehouseItems/{brand}/{posCode} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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