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
GetPurchaseItems Parameters:
NameParameterData TypeRequiredDescription
brandpathstringYesBrand
posCodesqueryList<string>YesPOS Legacy
articleCodesqueryList<string>NoArticle Codes
erpOrderCodesqueryList<string>NoERP Order Codes
pagequeryintNoIndex of the result set returned
itemsqueryintNoSize of the result set returned
noCountqueryboolNoOmit precise record count - save on performance
sortByquerystringNoSorting expression
GetPurchaseItemsResponse Parameters:
NameParameterData TypeRequiredDescription
totalPagesformintYesTotal Pages
totalResultsformintYesTotal Results
pageformintYesIndex of the result set returned
itemsformintYesSize of the result set returned
elementsformIEnumerable<PurchaseItem>YesList of purchase items
PurchaseItem Parameters:
NameParameterData TypeRequiredDescription
posCodeformstringYesPos Code
posCodeToBeDisplayedformstringYesPos Code To Be Displayed
erpOrderIdformintYesErp Order Id
lineNumberformintYesLine number
orderDateformstringYesOrder Date
originOrderIdformint?NoOrigin Order Id
articleCodeformstringYesArticle Code
orderedQuantityformintYesOrdered Quantity
openQuantityformintYesOpen Quantity
statusformstringYesOrder status
netAmountformAmountYesNet Amount
customerReferenceformstringYesCustomer Reference
speakingArticleCodeformstringYesSpeaking Article Code
expectedDeliveryDateformstringYesExpected Delivery Date
isStrapVipOrderformboolYesIs Strap Vip Order
orderTypeformstringYesOrder Type
Amount Parameters:
NameParameterData TypeRequiredDescription
valueformdecimalYesValue
currencyformstringYesCurrency

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

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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