Differences between API 2.1 and API 2.0

Last modified: 8. April 2022

API version 2.1 has the same methods in all areas (products, metadata, business) as the API 2.0.

However, there are some differences in the fields within data formats or in the behaviour of the API itself.

Here you will find an overview of the changes.

producs/ method

The data formats developerupdate, standardupdate have not changed in API 2.1. The data formats developer and standard have been supplemented by a few fields.

In the product section (developer, standard), the following fields are new:

  • eClassV7: eClass Version 7.0
  • customsTariffNumber: this field has only been moved to a new position within the document
  • UNSPSC: UNSPSC Classification Code
  • colorFamilyId: ID of the colour family (normalised colour)
  • colorFamily: colour family (normalised colour) – e.g. ‘grey’ instead of ‘space-grey’
  • combinedLengthAndGirth: girth dimension
  • netWeight: net weight
  • netDimX: net dimension X
  • netDimY: net dimension Y
  • netDimZ: net dimension Z
  • valueAddedTaxGermany: German VAT rate
  • energyEfficiencyClass: energy effieciency class
  • keySellingPoints: Key Selling Points
  • packageContents: scope of delivery
  • productFeatures: product features
  • htmlMainSpecs: main technical specifications of the product in short form, separated with br-tags
  • image1 renamed to imageHighRes1
  • contractTypeId: the ID of the product family for licence/service products
  • contractTypeName: the name of the product family for licence/service products.

In the supplierItem section (developer, standard), the following fields are new:

  • contractTypeId: the ID of the product family for licence/service products
  • contractTypeName: the name of the product family for licence/service products.

In the attributes section (only in standard), the following fields are new:

  • value: the base value for the feature (see article on base units), for text as a text module, for numbers as the smallest value.

The section historicalDataItem (developer, standard) is completely new and contains historical price and stock data.

business/deals/search method

Orders (deals) can also be searched for in API 2.1 by providing the shopping cart ID (cartId). It is possible to specify multiple cartIds, this will then return all orders contained within the specified shopping carts.

The following field has been added to the data format carts in API 2.1:

  • cartId: ID of the cart containing the deal

The cartIds can be passed as the filter parameter to our API, e.g.:

cartId=9d40ec2e-19bb-4126-9231-43a01ce675dd

The general cart’s ID is ‘pool’. We could now, for example, specify a search for the general cart and a second cart as follows:

cartId=9d40ec2e-19bb-4126-9231-43a01ce675dd,pool
Was this article helpful?
Dislike 0
Views: 161