Richemont.Booster2.PublicApi

<back to all web services

GetStock

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

    /** @description POS Legacy */
    // @ApiMember(Description="POS Legacy")
    public posCodes: string[];

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

    /** @description Include Extra Info */
    // @ApiMember(Description="Include Extra Info")
    public includeExtraInfo: boolean;

    /** @description Cluster Id */
    // @ApiMember(Description="Cluster Id")
    public clusterIds: string[];

    /** @description Include Consignment NotAuthorized POS */
    // @ApiMember(Description="Include Consignment NotAuthorized POS")
    public includeConsignmentNotAuthorizedPOS: 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;

    /** @description In Stock Since date from  */
    // @ApiMember(Description="In Stock Since date from ")
    public dateFrom?: string;

    /** @description In Stock Since date to */
    // @ApiMember(Description="In Stock Since date to")
    public dateTo?: string;

    /** @description Item type, 'standard' OR 'consigned'. By default, all are coming */
    // @ApiMember(Description="Item type, 'standard' OR 'consigned'. By default, all are coming")
    public type: string;

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

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

    /** @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 Country of the POS */
    // @ApiMember(Description="Country of the POS", IsRequired=true)
    public country: string;

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

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

    /** @description State */
    // @ApiMember(Description="State", IsRequired=true)
    public state: string;

    /** @description Street */
    // @ApiMember(Description="Street", IsRequired=true)
    public street: string;

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

export class UnitNetAmount
{
    /** @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<UnitNetAmount>) { (Object as any).assign(this, init); }
}

export class StockPositionItem
{
    /** @description Quantity */
    // @ApiMember(Description="Quantity", IsRequired=true)
    public quantity: number;

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

    /** @description Stock Date */
    // @ApiMember(Description="Stock Date", IsRequired=true)
    public stockDate: string;

    /** @description Loaded On Date */
    // @ApiMember(Description="Loaded On Date", IsRequired=true)
    public loadedOnDate: string;

    /** @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 Sell-In Price. Disclaimer: this data will be arriving empty/null due to DealerCost project still being in test phase. */
    // @ApiMember(Description="Sell-In Price. Disclaimer: this data will be arriving empty/null due to DealerCost project still being in test phase.")
    public unitNetAmount: UnitNetAmount;

    /** @description Retail Sales Price */
    // @ApiMember(Description="Retail Sales Price")
    public retailSalesPrice: UnitNetAmount;

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

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

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

    /** @description Serial Numbers */
    // @ApiMember(Description="Serial Numbers")
    public serialNumbers: string[];

    /** @description Stock Item in Details */
    // @ApiMember(Description="Stock Item in Details", IsRequired=true)
    public stockPositions: StockPositionItem[];

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

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

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

    /** @description Shared Stock Location */
    // @ApiMember(Description="Shared Stock Location", IsRequired=true)
    public sharedStockLocation: Pos;

    /** @description Stock Items */
    // @ApiMember(Description="Stock Items")
    public stockItems: StockItem[];

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

export class GetStockResponse extends Array<PosStockItem>
{

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

export class GetStock extends StockRequest
{

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

TypeScript GetStock DTOs

GET /stock/{brand} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[]