Richemont.Booster2.PublicApi

GetDeliveryNotePaginated

The following routes are available for this service:
GET	/deliveryNote/{brand}	Get a list of Delivery Notes

**GetDeliveryNotePaginated** Parameters:
Name	Parameter	Data Type	Required	Description
brand	path	string	Yes	Brand Trigram, e.g. CAR, IWC
posCodes	query	List<string>	Yes	POS Legacy Codes, e.g. ES100:102048
dateTo	query	DateTime?	No	Delivery notes date to
dateFrom	query	DateTime?	No	Delivery notes date from
status	query	List<string>	No	Status possible values: 'I' for pending delivery notes, 'P' for accepted ones
onlyConsignment	query	bool?	No	Provide value 'true' for getting only consignment delivery notes
orderType	query	string	No	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.
stockType	query	string	No	Stock type filter: “consigned“ for consigned products only ; “asset“ for standard products only ; empty for both consignment & asset
articleCode	query	string	No	Richemont Reference Code of the item
serialNumber	query	string	No	Serial Number of the item
deliveryNotesNumber	query	long?	No	Delivery notes number for getting specific delivery, e.g. 7032150324
icDeliveryNotesNumber	query	long?	No	IC Delivery notes number for getting specific delivery, e.g. 7032150324
erpOrderNumber	query	int?	No	Purchase order number for getting specific deliveries by order number, e.g 207285022
page	query	int	No	Index of the result set returned
items	query	int	No	Size of the result set returned
noCount	query	bool	No	Omit precise record count - save on performance
sortBy	query	string	No	Values can be 'DateDESC', 'DateASC', 'PosASC', 'PosDESC'

**GetDeliveryNotePaginatedResponse** Parameters:
Name	Parameter	Data Type	Required	Description
totalPages	form	int	Yes	Total Pages
totalResults	form	int	Yes	Total Results
page	form	int	Yes	Index of the result set returned
items	form	int	Yes	Size of the result set returned
elements	form	IEnumerable<DeliveryNote>	Yes	List of delivery notes

**DeliveryNote** Parameters:
Name	Parameter	Data Type	Required	Description
erpSystemId	form	string	Yes	ID of ERP system e.g. ES100
posCode	form	string	Yes	POS Legacy e.g. ES100:102048
shipToPosCode	form	string	Yes	ShipTo POS Legacy e.g. ES100:102048
deliveryNotesNumber	form	long	Yes	ID of Delivery note document e.g. 7032150324
deliveryNotesDate	form	DateTime	Yes	Date of Delivery note document e.g. '2023-01-01'
deliveryNoteItems	form	List<DeliveryNoteItem>	Yes	Delivery note items
icDeliveryNotesNumber	form	long?	Yes	ID of IC Delivery note document e.g. 7032150324
icDeliveryNotesDate	form	DateTime?	Yes	Date of IC Delivery note document e.g. '2023-01-01'

**DeliveryNoteItem** Parameters:
Name	Parameter	Data Type	Required	Description
deliveryNotesLineNumber	form	long	Yes	Line number of Delivery note document e.g. 10, 90, 10000
status	form	string	Yes	Status e.g. I, P
articleCode	form	string	Yes	Article code of product e.g. CRWGSA0032
articleDescription	form	string	No	Article description of product
speakingArticleCode	form	string	No	Article code of product for straps e.g. CRKD12346879
serialNumbers	form	List<string>	No	Serial numbers of products
erpOrderNumber	form	int	Yes	ERP ID of purchase order which delivery note attached to e.g. 200232323
erpOrderDate	form	DateTime	Yes	Date of purchase order which delivery note attached to e.g. '2023-01-01'
erpOrderLineNumber	form	int	Yes	Line number of purchase order which delivery note attached to e.g. '2023-01-01'
customerReference	form	string	No	Customer reference of order
carrier	form	string	No	Carrier name
trackingNumber	form	string	No	Tracking number
trackingUrl	form	string	No	Tracking URL
isSellable	form	bool	Yes	Flag that shows the order is sellable or not
isConsignment	form	bool	Yes	Flag that shows the order is consignment or not
isAutomaticReplenishment	form	bool?	Yes	Flag that shows the order is Automatic Replenishment or not
orderReasonCode	form	string	Yes	Order reason code
consignmentDueDate	form	DateTime?	No	Original quantity of item
quantity	form	int	Yes	Quantity of item
unitAmount	form	Amount2	Yes	Price of item

**Amount2** Parameters:
Name	Parameter	Data Type	Required	Description
currencyIsoCode	form	string	Yes	Currency ISO Code e.g. EUR, USD
value	form	double	Yes	Cost

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

HTTP + CSV

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: text/csv

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

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