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
storageLocationIdquerystringNoStorage Location Identifier e.g. CPO, NEW, REP
inventorySegmentquerystringNoInventory segment e.g. CPO or null
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
storageLocationformStorageLocationNoStorage Location
RetailSalesPrice Parameters:
NameParameterData TypeRequiredDescription
currencyIsoCodeformstringYesCurrency Iso Code
valueformdecimal?YesValue
StorageLocation Parameters:
NameParameterData TypeRequiredDescription
storageLocationIdformstringYesStorage Location Identifier
storageLocationDsformstringNoStorage Location Description

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 /stock/{brand}/{posCode} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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