Richemont.Booster2.PublicApi

<back to all web services

ExportStock

Requires Authentication
The following routes are available for this service:
POST/stock/{brand}/exportExport Stock Data
ExportStock Parameters:
NameParameterData TypeRequiredDescription
productCategoriesbodyList<ProductCategory>NoProduct Categories
downloadRequestIdbodystringYesExport Request ID of the API Consumers
StockRequest Parameters:
NameParameterData TypeRequiredDescription
brandformstringYesBrand
posCodesformList<string>NoPOS Legacy
articleCodesformList<string>NoArticle Codes
includeExtraInfoformboolNoInclude Extra Info
clusterIdsformList<string>NoCluster Id
includeConsignmentNotAuthorizedPOSformboolNoInclude Consignment NotAuthorized POS
includeRSPformboolNoInclude Retail Sales Price in the Output, by default: false
dateFromformDateTime?NoIn Stock Since date from
dateToformDateTime?NoIn Stock Since date to
typeformstringNoItem type, 'standard' OR 'consigned'. By default, all are coming
ProductCategory Parameters:
NameParameterData TypeRequiredDescription
brandCategoryIdformstringNoBrand Category ID
grandCategoryIdformstringYesGrand Category ID
masterCategoryIdformstringNoMaster Category ID
categoryIdformstringNoCategory ID
subCategoryIdformstringNoSub Category ID
ExportStockResponse Parameters:
NameParameterData TypeRequiredDescription
asyncTaskIdformGuidYesUnique Identifier of the Export Request created

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.

POST /stock/{brand}/export HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	productCategories: 
	[
		{
			brandCategoryId: String,
			grandCategoryId: String,
			masterCategoryId: String,
			categoryId: String,
			subCategoryId: String
		}
	],
	downloadRequestId: String,
	brand: String,
	posCodes: 
	[
		String
	],
	articleCodes: 
	[
		String
	],
	includeExtraInfo: False,
	clusterIds: 
	[
		String
	],
	includeConsignmentNotAuthorizedPOS: False,
	includeRSP: False,
	dateFrom: 0001-01-01,
	dateTo: 0001-01-01,
	type: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	asyncTaskId: 00000000000000000000000000000000
}