Richemont.Booster2.PublicApi

<back to all web services

GetStockDetail

Requires Authentication
The following routes are available for this service:
GET/stock/{brand}/{posCode}/{articleCode}Get stock details
GetStockDetail Parameters:
NameParameterData TypeRequiredDescription
brandpathstringYesBrand
posCodepathstringYesPOS Legacy
articleCodepathstringYesArticle Code
GetStockDetailResponse Parameters:
NameParameterData TypeRequiredDescription
articleCodeformstringYesArticle code
brandformstringYesBrand
posCodeformstringYesPos Code
currentStockQuantityformintYesCurrent Stock Quantity
sharedStockLocationformPosYesShared Stock Location
stockPositionsformList<StockPositionItem>YesStock Positions
Pos Parameters:
NameParameterData TypeRequiredDescription
nameformstringYesName of the POS
posCodeformstringYesPOS Code
posCodeToBeDisplayedformstringYesPos Code To Be Displayed
countryformstringYesCountry of the POS
cityformstringYesCity of the POS
postalCodeformstringYesPostal Code
stateformstringYesState
streetformstringYesStreet
StockPositionItem Parameters:
NameParameterData TypeRequiredDescription
quantityformintYesQuantity
serialNumberformstringNoSerial Number
stockDateformstringYesStock Date
loadedOnDateformstringYesLoaded On Date
typeformstringYesType e.g. consignment or standard
isConsignmentSellableformboolYesIs Consignment Sellable
unitNetAmountformUnitNetAmountNoSell-In Price. Disclaimer: this data will be arriving empty/null due to DealerCost project still being in test phase.
retailSalesPriceformUnitNetAmountNoRetail Sales Price
UnitNetAmount Parameters:
NameParameterData TypeRequiredDescription
currencyIsoCodeformstringYesCurrency Iso Code
valueformdecimal?YesValue

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

HTTP + JSV

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

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

{
	articleCode: String,
	brand: String,
	posCode: String,
	currentStockQuantity: 0,
	sharedStockLocation: 
	{
		name: String,
		posCode: String,
		posCodeToBeDisplayed: String,
		country: String,
		city: String,
		postalCode: String,
		state: String,
		street: String
	},
	stockPositions: 
	[
		{
			quantity: 0,
			serialNumber: String,
			stockDate: String,
			loadedOnDate: String,
			type: String,
			isConsignmentSellable: False,
			unitNetAmount: 
			{
				currencyIsoCode: String,
				value: 0
			},
			retailSalesPrice: 
			{
				currencyIsoCode: String,
				value: 0
			}
		}
	]
}