The API 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 behavior of the API itself.

Here is an overview of the changes

producs/ method

The data formats developerupdate, standardupdate have not changed in API 2.1. The data formats developer aund 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, wurde nur in der Position innerhalb des Dokuments verschoben
  • UNSPSC: UNSPSC Classification Code
  • colorFamilyId: Id der Farbfamilie (normalisierte Farbe)
  • colorFamily : Farbfamilie (normalisierte Farbe) z.B. grau statt space-grau oder maus-grau
  • combinedLengthAndGirth: Gurtmaß 
  • netWeight: Nettogewicht
  • netDimX: Nettomaß X
  • netDimY: Nettomaß Y
  • netDimZ: Nettomaß Z
  • valueAddedTaxGermany: Deutscher Umsatzsteuersatz
  • energyEfficiencyClass: Energieeffizienzklasse
  • keySellingPoints: Key Selling Points
  • packageContents: Lieferumfang
  • productFeatures: Produktfeatures
  • htmlMainSpecs: Technische Eigenschaften des Produktes in Kurzform, getrennt mit br-Tags
  • contractTypeId: The contracttype within License- and Serviceproducts
  • contractTypeName: The name of the contracttype within License- and Serviceproducts

Im Abschnitt supplierItem (developer, standard) sind folgende Felder neu:

  • contractTypeId: The contracttype within License- and Serviceproducts
  • contractTypeName: The name of the contracttype within License- and Serviceproducts

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

  • value: Der Basiswert (siehe auch Basiseinheit) der Eigenschaft, bei Text als Textbaustein, bei Zahlen als kleinste Angabe

business/deals/send method

Hardware articles do not need this additional information. Only items with license contractTypeId> 0 (Physical).

Via the order API 2.1 it is only possible to receive ESD orders for certain distributors (see overview)

ESD orders are pre-shipped to the Distributor and, in violation of these rules, the order is rejected by the API, and the reason returned as a Repsonse.

The following rules apply when submitting an ESD order:

  • When ordering documents containing ESD information, Opentrans Remarks itscontractype or itsesdemail, are sent to API 2.0, these additional OpenTrans Remarks items in API 2.0 are removed from the document
  • Rules for Remarks type="itscontracttype":
    • may only be specified once per ORDER_ITEM
    • the Remarks type = "itscontracttype" must always be transmitted in lowercase letters
    • valid license agreement type name must be transmitted in correct spelling. Currently only ESD is supported. Other contract types will follow later
  • Rules for Remarks type="itsesdemail":
    • may only be specified once per ORDER_ITEM
    • the remarks type="itsesdemail" must always be transmitted in lowercase letters
    • must always be used in conjunction with Remarks type itscontracttype ESD
    • the content of the Remarks element can not be empty
    • the content of the Remarks element must receive a valid email address (email format)
    • there are no different Esd emails allowed within an order
  • Rules for Party Customer:
    • for ESD orders, only one customer party must always be specified in ORDER_HEADER
  • Rules for CUSTOMER_ORDER_REFERENCE:
    • may only be specified once per ORDER_ITEM
    • CUSTOMER_IDREF may only point to a Customer Party
    • CUSTOMER_IDREF must not point to an invalid Customer Party
  • The ESD position within the order is always checked against the license contract type of the source of supply on ITscope.com
    • Order item ESD and source ESD: OK
    • Order item ESD and source of supply unknown: OK
    • Order item ESD and source not ESD: error
    • Order item not ESD and source not ESD, but product ESD: OK
    • Order item not ESD and source of supply ESD: error
    • mixed orders are allowed, i. ESD and Physical positions within the order, the rules apply as described above
    • pure ESD orders are allowed, there are only ESD positions within the order, the rule as described above applies
      • with pure ESD orders dropshipment is not allowed, UDX.DROPSHIPMENT must be set to false in this case

 

 

 

 

Note: This page has been translated with the Google Translation Service.

Have more questions? Submit a request