Richemont.Booster2.PublicApi

<back to all web services

GetPurchaseItems

Requires Authentication
The following routes are available for this service:
GET/purchaseItem/{brand}Get a list of purchase details

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

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

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

export class PurchaseItem
{
    /** @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 Erp Order Id */
    // @ApiMember(Description="Erp Order Id", IsRequired=true)
    public erpOrderId: number;

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

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

    /** @description Origin Order Id */
    // @ApiMember(Description="Origin Order Id")
    public originOrderId?: number;

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

    /** @description Ordered Quantity */
    // @ApiMember(Description="Ordered Quantity", IsRequired=true)
    public orderedQuantity: number;

    /** @description Open Quantity */
    // @ApiMember(Description="Open Quantity", IsRequired=true)
    public openQuantity: number;

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

    /** @description Net Amount */
    // @ApiMember(Description="Net Amount", IsRequired=true)
    public netAmount: Amount;

    /** @description Customer Reference */
    // @ApiMember(Description="Customer Reference", IsRequired=true)
    public customerReference: string;

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

    /** @description Expected Delivery Date */
    // @ApiMember(Description="Expected Delivery Date", IsRequired=true)
    public expectedDeliveryDate: string;

    /** @description Is Strap Vip Order */
    // @ApiMember(Description="Is Strap Vip Order", IsRequired=true)
    public isStrapVipOrder: boolean;

    /** @description Order Type */
    // @ApiMember(Description="Order Type", IsRequired=true)
    public orderType: string;

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

export class GetPurchaseItemsResponse
{
    /** @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 purchase items */
    // @ApiMember(Description="List of purchase items", IsRequired=true)
    public elements: PurchaseItem[];

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

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

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

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

    /** @description ERP Order Codes */
    // @ApiMember(Description="ERP Order Codes")
    public erpOrderCodes: 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<GetPurchaseItems>) { (Object as any).assign(this, init); }
}

TypeScript GetPurchaseItems DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /purchaseItem/{brand} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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