Richemont.Booster2.PublicApi

<back to all web services

GetStockPaginated

export class RetailSalesPrice
{
    /** @description Currency Iso Code */
    // @ApiMember(Description="Currency Iso Code", IsRequired=true)
    public currencyIsoCode: string;

    /** @description Value */
    // @ApiMember(Description="Value", IsRequired=true)
    public value: number;

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

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

    /** @description Pos Code To Be Displayed */
    // @ApiMember(Description="Pos Code To Be Displayed", IsRequired=true)
    public posCodeToBeDisplayed: string;

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

    /** @description Serial Number */
    // @ApiMember(Description="Serial Number")
    public serialNumber: string;

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

    /** @description Type e.g. consignment or standard */
    // @ApiMember(Description="Type e.g. consignment or standard", IsRequired=true)
    public type: string;

    /** @description Is Consignment Sellable  */
    // @ApiMember(Description="Is Consignment Sellable ", IsRequired=true)
    public isConsignmentSellable: boolean;

    /** @description Retail Sales Price */
    // @ApiMember(Description="Retail Sales Price", IsRequired=true)
    public retailSalesPrice: RetailSalesPrice;

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

export class GetStockPaginatedResponse
{
    /** @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: PaginatedStockElement[];

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

export class GetStockPaginated 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 Search Key (Article or SerialNumber) */
    // @ApiMember(Description="Search Key (Article or SerialNumber)")
    public searchKey: 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;

    /** @description Parameter - Include Chain POSes Stock  */
    // @ApiMember(Description="Parameter - Include Chain POSes Stock ")
    public includeChainPosesStock: boolean;

    /** @description Include Retail Sales Price in the Output, by default: false */
    // @ApiMember(Description="Include Retail Sales Price in the Output, by default: false")
    public includeRSP: boolean;

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

TypeScript GetStockPaginated DTOs

GET /stock/{brand}/{posCode} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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