| GET | /purchaseItem/{brand} | Get a list of purchase details |
|---|
"use strict";
export class Amount {
/** @param {{value?:number,currency?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description Value */
value;
/**
* @type {string}
* @description Currency */
currency;
}
export class PurchaseItem {
/** @param {{posCode?:string,posCodeToBeDisplayed?:string,erpOrderId?:number,lineNumber?:number,orderDate?:string,originOrderId?:number,articleCode?:string,orderedQuantity?:number,openQuantity?:number,status?:string,netAmount?:Amount,customerReference?:string,speakingArticleCode?:string,expectedDeliveryDate?:string,isStrapVipOrder?:boolean,orderType?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Pos Code */
posCode;
/**
* @type {string}
* @description Pos Code To Be Displayed */
posCodeToBeDisplayed;
/**
* @type {number}
* @description Erp Order Id */
erpOrderId;
/**
* @type {number}
* @description Line number */
lineNumber;
/**
* @type {string}
* @description Order Date */
orderDate;
/**
* @type {?number}
* @description Origin Order Id */
originOrderId;
/**
* @type {string}
* @description Article Code */
articleCode;
/**
* @type {number}
* @description Ordered Quantity */
orderedQuantity;
/**
* @type {number}
* @description Open Quantity */
openQuantity;
/**
* @type {string}
* @description Order status */
status;
/**
* @type {Amount}
* @description Net Amount */
netAmount;
/**
* @type {string}
* @description Customer Reference */
customerReference;
/**
* @type {string}
* @description Speaking Article Code */
speakingArticleCode;
/**
* @type {string}
* @description Expected Delivery Date */
expectedDeliveryDate;
/**
* @type {boolean}
* @description Is Strap Vip Order */
isStrapVipOrder;
/**
* @type {string}
* @description Order Type */
orderType;
}
export class GetPurchaseItemsResponse {
/** @param {{totalPages?:number,totalResults?:number,page?:number,items?:number,elements?:PurchaseItem[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description Total Pages */
totalPages;
/**
* @type {number}
* @description Total Results */
totalResults;
/**
* @type {number}
* @description Index of the result set returned */
page;
/**
* @type {number}
* @description Size of the result set returned */
items;
/**
* @type {PurchaseItem[]}
* @description List of purchase items */
elements;
}
export class GetPurchaseItems {
/** @param {{brand?:string,posCodes?:string[],articleCodes?:string[],erpOrderCodes?:string[],page?:number,items?:number,noCount?:boolean,sortBy?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Brand */
brand;
/**
* @type {string[]}
* @description POS Legacy */
posCodes;
/**
* @type {string[]}
* @description Article Codes */
articleCodes;
/**
* @type {string[]}
* @description ERP Order Codes */
erpOrderCodes;
/**
* @type {number}
* @description Index of the result set returned */
page;
/**
* @type {number}
* @description Size of the result set returned */
items;
/**
* @type {boolean}
* @description Omit precise record count - save on performance */
noCount;
/**
* @type {string}
* @description Sorting expression */
sortBy;
}
JavaScript GetPurchaseItems DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}