| GET | /deliveryNote/{brand} | Get a list of Delivery Notes |
|---|
"use strict";
export class Amount2 {
/** @param {{currencyIsoCode?:string,value?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Currency ISO Code e.g. EUR, USD */
currencyIsoCode;
/**
* @type {number}
* @description Cost */
value;
}
export class DeliveryNoteItem {
/** @param {{deliveryNotesLineNumber?:number,status?:string,articleCode?:string,articleDescription?:string,speakingArticleCode?:string,serialNumbers?:string[],erpOrderNumber?:number,erpOrderDate?:string,erpOrderLineNumber?:number,customerReference?:string,carrier?:string,trackingNumber?:string,trackingUrl?:string,isSellable?:boolean,isConsignment?:boolean,isAutomaticReplenishment?:boolean,orderReasonCode?:string,consignmentDueDate?:string,quantity?:number,unitAmount?:Amount2}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description Line number of Delivery note document e.g. 10, 90, 10000 */
deliveryNotesLineNumber;
/**
* @type {string}
* @description Status e.g. I, P */
status;
/**
* @type {string}
* @description Article code of product e.g. CRWGSA0032 */
articleCode;
/**
* @type {string}
* @description Article description of product */
articleDescription;
/**
* @type {string}
* @description Article code of product for straps e.g. CRKD12346879 */
speakingArticleCode;
/**
* @type {string[]}
* @description Serial numbers of products */
serialNumbers;
/**
* @type {number}
* @description ERP ID of purchase order which delivery note attached to e.g. 200232323 */
erpOrderNumber;
/**
* @type {string}
* @description Date of purchase order which delivery note attached to e.g. '2023-01-01' */
erpOrderDate;
/**
* @type {number}
* @description Line number of purchase order which delivery note attached to e.g. '2023-01-01' */
erpOrderLineNumber;
/**
* @type {string}
* @description Customer reference of order */
customerReference;
/**
* @type {string}
* @description Carrier name */
carrier;
/**
* @type {string}
* @description Tracking number */
trackingNumber;
/**
* @type {string}
* @description Tracking URL */
trackingUrl;
/**
* @type {boolean}
* @description Flag that shows the order is sellable or not */
isSellable;
/**
* @type {boolean}
* @description Flag that shows the order is consignment or not */
isConsignment;
/**
* @type {boolean}
* @description Flag that shows the order is Automatic Replenishment or not */
isAutomaticReplenishment;
/**
* @type {string}
* @description Order reason code */
orderReasonCode;
/**
* @type {?string}
* @description Original quantity of item */
consignmentDueDate;
/**
* @type {number}
* @description Quantity of item */
quantity;
/**
* @type {Amount2}
* @description Price of item */
unitAmount;
}
export class DeliveryNote {
/** @param {{erpSystemId?:string,posCode?:string,shipToPosCode?:string,deliveryNotesNumber?:number,deliveryNotesDate?:string,deliveryNoteItems?:DeliveryNoteItem[],icDeliveryNotesNumber?:number,icDeliveryNotesDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description ID of ERP system e.g. ES100 */
erpSystemId;
/**
* @type {string}
* @description POS Legacy e.g. ES100:102048 */
posCode;
/**
* @type {string}
* @description ShipTo POS Legacy e.g. ES100:102048 */
shipToPosCode;
/**
* @type {number}
* @description ID of Delivery note document e.g. 7032150324 */
deliveryNotesNumber;
/**
* @type {string}
* @description Date of Delivery note document e.g. '2023-01-01' */
deliveryNotesDate;
/**
* @type {DeliveryNoteItem[]}
* @description Delivery note items */
deliveryNoteItems;
/**
* @type {number}
* @description ID of IC Delivery note document e.g. 7032150324 */
icDeliveryNotesNumber;
/**
* @type {string}
* @description Date of IC Delivery note document e.g. '2023-01-01' */
icDeliveryNotesDate;
}
export class GetDeliveryNotePaginatedResponse {
/** @param {{totalPages?:number,totalResults?:number,page?:number,items?:number,elements?:DeliveryNote[]}} [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 {DeliveryNote[]}
* @description List of delivery notes */
elements;
}
export class GetDeliveryNotePaginated {
/** @param {{brand?:string,posCodes?:string[],dateTo?:string,dateFrom?:string,status?:string[],onlyConsignment?:boolean,orderType?:string,stockType?:string,articleCode?:string,serialNumber?:string,deliveryNotesNumber?:number,icDeliveryNotesNumber?:number,erpOrderNumber?:number,page?:number,items?:number,noCount?:boolean,sortBy?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Brand Trigram, e.g. CAR, IWC */
brand;
/**
* @type {string[]}
* @description POS Legacy Codes, e.g. ES100:102048 */
posCodes;
/**
* @type {?string}
* @description Delivery notes date to */
dateTo;
/**
* @type {?string}
* @description Delivery notes date from */
dateFrom;
/**
* @type {string[]}
* @description Status possible values: 'I' for pending delivery notes, 'P' for accepted ones */
status;
/**
* @type {?boolean}
* @description Provide value 'true' for getting only consignment delivery notes */
onlyConsignment;
/**
* @type {?string}
* @description Order type filter: “autorep“ for getting only delivery notes linked to an automatic replenishment trigger. It means the reason codes Auto Repl Standard (Z22) and Auto Repl Consignment (Z89) ; “manual“ for getting only delivery notes linked to a manual replenishment trigger. It means all the other reason codes. */
orderType;
/**
* @type {?string}
* @description Stock type filter: “consigned“ for consigned products only ; “asset“ for standard products only ; empty for both consignment & asset */
stockType;
/**
* @type {?string}
* @description Richemont Reference Code of the item */
articleCode;
/**
* @type {?string}
* @description Serial Number of the item */
serialNumber;
/**
* @type {?number}
* @description Delivery notes number for getting specific delivery, e.g. 7032150324 */
deliveryNotesNumber;
/**
* @type {?number}
* @description IC Delivery notes number for getting specific delivery, e.g. 7032150324 */
icDeliveryNotesNumber;
/**
* @type {?number}
* @description Purchase order number for getting specific deliveries by order number, e.g 207285022 */
erpOrderNumber;
/**
* @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 Values can be 'DateDESC', 'DateASC', 'PosASC', 'PosDESC' */
sortBy;
}
JavaScript GetDeliveryNotePaginated DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /deliveryNote/{brand} 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}