<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 .xml suffix or ?format=xml

HTTP + XML

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

POST /xml/reply/Products HTTP/1.1 
Host: webservice.kruitbosch.nl 
Content-Type: application/xml
Content-Length: length

<Products xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webservices.ServiceModel.Operations">
  <Categories xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Categories>
  <Category>String</Category>
  <ConsumerProducts>0</ConsumerProducts>
  <ExcludeBlocked>false</ExcludeBlocked>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Ids>
  <IncludeAdditionalImages>false</IncludeAdditionalImages>
  <IncludeAttributes>false</IncludeAttributes>
  <IncludeInActive>false</IncludeInActive>
  <IncludeIntrastatCodes>false</IncludeIntrastatCodes>
  <IncludeOriginalImages>false</IncludeOriginalImages>
  <IsBike>false</IsBike>
  <ProductOptions>false</ProductOptions>
</Products>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProductsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webservices.ServiceModel.Operations">
  <Products xmlns:d2p1="http://schemas.datacontract.org/2004/07/Webservices.ServiceModel.Types">
    <d2p1:Product>
      <d2p1:AdditionalImages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:AdditionalImages>
      <d2p1:Attributes>
        <d2p1:AttributeClass>
          <d2p1:Attribute>String</d2p1:Attribute>
          <d2p1:AttributeValue>String</d2p1:AttributeValue>
        </d2p1:AttributeClass>
      </d2p1:Attributes>
      <d2p1:Autorisation>String</d2p1:Autorisation>
      <d2p1:Bike>false</d2p1:Bike>
      <d2p1:Blocked>false</d2p1:Blocked>
      <d2p1:DateCreated>0001-01-01T00:00:00</d2p1:DateCreated>
      <d2p1:DeliveredPer>0</d2p1:DeliveredPer>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:DescriptionLong>String</d2p1:DescriptionLong>
      <d2p1:EANCode>0</d2p1:EANCode>
      <d2p1:Image>String</d2p1:Image>
      <d2p1:InActive>false</d2p1:InActive>
      <d2p1:IntrastatCode>String</d2p1:IntrastatCode>
      <d2p1:KboGroup>String</d2p1:KboGroup>
      <d2p1:OriginalImages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:OriginalImages>
      <d2p1:PackageQuantity>0</d2p1:PackageQuantity>
      <d2p1:PriceGross>0</d2p1:PriceGross>
      <d2p1:ProductCode>String</d2p1:ProductCode>
      <d2p1:ProductGroup>String</d2p1:ProductGroup>
      <d2p1:ProductGroupCategory>String</d2p1:ProductGroupCategory>
      <d2p1:ProductGroupLevel1>String</d2p1:ProductGroupLevel1>
      <d2p1:ProductGroupLevel2>String</d2p1:ProductGroupLevel2>
      <d2p1:ProductGroupLevel3>String</d2p1:ProductGroupLevel3>
      <d2p1:ProductGroupLevel4>String</d2p1:ProductGroupLevel4>
      <d2p1:ProductOptions>
        <d2p1:ProductOptionClass>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:ProductCode>String</d2p1:ProductCode>
          <d2p1:RecommendedSalesPrice>0</d2p1:RecommendedSalesPrice>
          <d2p1:Type>String</d2p1:Type>
        </d2p1:ProductOptionClass>
      </d2p1:ProductOptions>
      <d2p1:RecommendedSalesPrice>0</d2p1:RecommendedSalesPrice>
      <d2p1:StockMax>0</d2p1:StockMax>
      <d2p1:StockMin>0</d2p1:StockMin>
      <d2p1:SupplierProductNumber>String</d2p1:SupplierProductNumber>
      <d2p1:Unit>String</d2p1:Unit>
      <d2p1:UnitAlternative>String</d2p1:UnitAlternative>
      <d2p1:VAT>String</d2p1:VAT>
    </d2p1:Product>
  </Products>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</ProductsResponse>