Richemont.Booster2.PublicApi

<back to all web services

GetStockPaginated

Requires Authentication
The following routes are available for this service:
GET/stock/{brand}/{posCode}Get Paginated Stock
GetStockPaginated Parameters:
NameParameterData TypeRequiredDescription
brandpathstringYesBrand
posCodepathstringYesPOS Legacy
searchKeyquerystringNoSearch Key (Article or SerialNumber)
pagequeryintNoIndex of the result set returned
itemsqueryintNoSize of the result set returned
noCountqueryboolNoOmit precise record count - save on performance
sortByquerystringNoSorting expression
includeChainPosesStockqueryboolNoParameter - Include Chain POSes Stock
includeRSPqueryboolNoInclude Retail Sales Price in the Output, by default: false
GetStockPaginatedResponse Parameters:
NameParameterData TypeRequiredDescription
totalPagesformintYesTotal Pages
totalResultsformintYesTotal Results
pageformintYesIndex of the result set returned
itemsformintYesSize of the result set returned
elementsformIEnumerable<PaginatedStockElement>YesList of movements
PaginatedStockElement Parameters:
NameParameterData TypeRequiredDescription
posCodeformstringYesPos Code
posCodeToBeDisplayedformstringYesPos Code To Be Displayed
articleCodeformstringYesArticle Code
serialNumberformstringNoSerial Number
quantityformintYesCurrent Stock Quantity
typeformstringYesType e.g. consignment or standard
isConsignmentSellableformboolYesIs Consignment Sellable
retailSalesPriceformRetailSalesPriceYesRetail Sales Price
RetailSalesPrice Parameters:
NameParameterData TypeRequiredDescription
currencyIsoCodeformstringYesCurrency Iso Code
valueformdecimal?YesValue

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

HTTP + XML

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

GET /stock/{brand}/{posCode} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetStockPaginatedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Stock.ServiceModel">
  <elements i:nil="true" />
  <items>0</items>
  <page>0</page>
  <totalPages>0</totalPages>
  <totalResults>0</totalResults>
</GetStockPaginatedResponse>