s1 API Host

<back to all web services

GetProductAugmentationRequest

The following routes are available for this service:
GET, OPTIONS/api/admin/productaugmentation/{masterproductid}Get the Product Augmentation.User has to be authenticated and admin to retrieve the information.
Parameters:
NameParameterData TypeRequiredDescription
masterproductidpathstringYes

To override the Content-type in your clients 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 /jsv/reply/GetProductAugmentationRequest HTTP/1.1 
Host: s1-api-tst.fource.nl 
Content-Type: text/jsv
Content-Length: length

{
	masterProductId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	productAugmentation: 
	{
		masterProductId: String,
		hideErpDescription: False,
		allowTecdocInformation: False,
		product: 
		{
			id: String,
			articleDataId: String,
			alfaCode: String,
			articleNo: String,
			name: String,
			commercialName: String,
			description: String,
			shortDescription: String,
			longDescription: String,
			brandName: String,
			brandId: String,
			productGroup: String,
			productGroupId: String,
			boschProductGroupId: String,
			requiresLegitimation: False,
			isGaik: False,
			isNotRetourable: False,
			isFGas: False,
			canBackorder: False,
			nettoPrice: 0,
			brutoPrice: 0,
			isLeadSurcharge: False,
			leadSurcharge: 0,
			isDisposalFee: False,
			disposalFee: 0,
			priceLabel: String,
			unitsPerSale: 0,
			quantityLinkedWarehouse: 0,
			quantityAllWarehouses: 0,
			depositFee: 0,
			environmentalTax: 0,
			removalFee: 0,
			hasCharacteristic: False,
			countryCode: String,
			availableLinkedWarehouse: 0001-01-01,
			availableNextRoute: 0001-01-01,
			routeExpiryDate: 0001-01-01,
			isNextRoute: False,
			isVheckRoute: False,
			isInPromotion: False,
			isNettoPriceProvided: False,
			isRouteInfoProvided: False,
			isKnownProduct: False,
			relevance: 0,
			brandLabel: Onbekend,
			sortOrder: 0,
			origins: 0,
			hasSetParts: False,
			setParts: {},
			isRentalProduct: False,
			isLeisureProduct: False,
			isLeisureProductText: Nee,
			hasCompatibleCars: False,
			hbase: 
			{
				productId: String,
				productGroupId: String,
				name: String
			},
			heijl: 
			{
				productId: String,
				productGroupId: String,
				name: String
			},
			tecDoc: 
			{
				productId: String,
				productGroupId: String,
				name: String
			},
			universalParts: 
			{
				productId: String,
				productGroupId: String,
				name: String
			},
			toolSpecial: 
			{
				productId: String,
				productGroupId: String,
				name: String
			},
			autoElectra: 
			{
				productId: String
			},
			aldoc: 
			{
				productId: String,
				brandId: String,
				brandName: String
			}
		},
		name: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String
			}
		]
	}
}