Richemont.Booster2.PublicApi

<back to all web services

GetBuyInPaginated

Requires Authentication
The following routes are available for this service:
GET/buyin/{brand}Get list of buyinGet list of paginated buyin based on the search parameters submitted
GetBuyInPaginated Parameters:
NameParameterData TypeRequiredDescription
brandpathstringYesRichemont Brand ID
posCodequerystringYesRichemont POS code
articleCodequerystringYesRichemont Reference Code of the item
serialNumberquerystringYesSerial Number of the item
buyInStatusIdquerystringYesBuy-in order status code
isInStockquerybool?NoTrue is the buy-in’s piece is in stock, False otherwise
pagequeryintYesIndex of the result set returned
itemsqueryintYesSize of the result set returned
noCountqueryboolNoOmit precise record count - save on performance
sortByquerystringYesSort Expression, Possible values: 'SaleDetailIdDESC', 'DocumentDate'.
GetBuyInPaginatedResponse Parameters:
NameParameterData TypeRequiredDescription
pageformintYesIndex of the result set returnedr
itemsformintYesSize of the result set returned
totalPagesformintYesTotal amount of pages / result sets
totalResultsformintYesTotal amount of results
elementsformIEnumerable<BuyIn>YesList of Sale Details
BuyIn Parameters:
NameParameterData TypeRequiredDescription
brandformstringYesBrand Trigram, e.g. CAR, IWC; compulsory only if articleCode is not provided
buyInOrderIdformintYesCode of BuyIn
posCodeformstringYesRichemont POS code
articleCodeformstringYesRichemont Reference Code of the item
serialNumberformstringYesSerial Number of the item
buyInStatusIdformstringYesBuy-in order status code
buyInDateformDateTimeNoBuy-in creation date
saleRepresentativeEmailsformList<string>YesEmails of Sale Representatives
isInStockformboolNoTrue is the buy-in’s piece is in stock, False otherwise

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

HTTP + OTHER

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

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

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