<back to all web services

Products

Requires Authentication
Requires any of the roles:Klant, Kassasysteem
The following routes are available for this service:
GET/Products/{Category}/{Categories}
GET/Products/{Ids}
GET/Products
Products Parameters:
NameParameterData TypeRequiredDescription
IdspathList<string>No
CategorypathstringNo
CategoriespathList<string>No
IsBikequerybool?No
ExcludeBlockedquerybool?No
IncludeAttributesquerybool?No
IncludeAdditionalImagesquerybool?No
IncludeOriginalImagesquerybool?No
IncludeIntrastatCodesquerybool?No
ConsumerProductsqueryint?No
IncludeInActivequerybool?No
ProductOptionsquerybool?No
ProductsResponse Parameters:
NameParameterData TypeRequiredDescription
ProductsformList<Product>No
ResponseStatusformResponseStatusNo
Product Parameters:
NameParameterData TypeRequiredDescription
ProductCodeformstringNo
BlockedformboolNo
DateCreatedformDateTimeNo
UnitformstringNo
DeliveredPerformdecimal?No
UnitAlternativeformstringNo
DescriptionformstringNo
ProductGroupCategoryformstringNo
ProductGroupformstringNo
ProductGroupLevel1formstringNo
ProductGroupLevel2formstringNo
ProductGroupLevel3formstringNo
ProductGroupLevel4formstringNo
EANCodeformdecimal?No
PackageQuantityformdecimal?No
DescriptionLongformstringNo
RecommendedSalesPriceformdecimal?No
PriceGrossformdecimal?No
SupplierProductNumberformstringNo
VATformstringNo
Bikeformbool?No
StockMinformdecimal?No
StockMaxformdecimal?No
AutorisationformstringNo
KboGroupformstringNo
ImageformstringNo
AttributesformList<AttributeClass>No
AdditionalImagesformList<string>No
OriginalImagesformList<string>No
InActiveformboolNo
ProductOptionsformList<ProductOptionClass>No
IntrastatCodeformstringNo
AttributeClass Parameters:
NameParameterData TypeRequiredDescription
AttributeformstringNo
AttributeValueformstringNo
ProductOptionClass Parameters:
NameParameterData TypeRequiredDescription
TypeformstringNo
ProductCodeformstringNo
DescriptionformstringNo
RecommendedSalesPriceformdecimal?No

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 /jsv/reply/Products HTTP/1.1 
Host: webservice.kruitbosch.nl 
Content-Type: text/jsv
Content-Length: length

{
	Ids: 
	[
		String
	],
	Category: String,
	Categories: 
	[
		String
	],
	IsBike: False,
	ExcludeBlocked: False,
	IncludeAttributes: False,
	IncludeAdditionalImages: False,
	IncludeOriginalImages: False,
	IncludeIntrastatCodes: False,
	ConsumerProducts: 0,
	IncludeInActive: False,
	ProductOptions: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Products: 
	[
		{
			ProductCode: String,
			Blocked: False,
			DateCreated: 0001-01-01,
			Unit: String,
			DeliveredPer: 0,
			UnitAlternative: String,
			Description: String,
			ProductGroupCategory: String,
			ProductGroup: String,
			ProductGroupLevel1: String,
			ProductGroupLevel2: String,
			ProductGroupLevel3: String,
			ProductGroupLevel4: String,
			EANCode: 0,
			PackageQuantity: 0,
			DescriptionLong: String,
			RecommendedSalesPrice: 0,
			PriceGross: 0,
			SupplierProductNumber: String,
			VAT: String,
			Bike: False,
			StockMin: 0,
			StockMax: 0,
			Autorisation: String,
			KboGroup: String,
			Image: String,
			Attributes: 
			[
				{
					Attribute: String,
					AttributeValue: String
				}
			],
			AdditionalImages: 
			[
				String
			],
			OriginalImages: 
			[
				String
			],
			InActive: False,
			ProductOptions: 
			[
				{
					Type: String,
					ProductCode: String,
					Description: String,
					RecommendedSalesPrice: 0
				}
			],
			IntrastatCode: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}