company metadata methods

Last modified: 30. June 2025
Unterpunkte

Manufacturer list (metadata)

The API provides methods for accessing manufacturer metadata.

  1. manufacturer/company.xml: list of all manufacturers in XML format
  2. manufacturer/company.json: list of all manufacturers in the JSON format

for example:
https://api.itscope.com/2.1/company/manufacturer/company.xml
or
https://api.itscope.com/2.1/company/manufacturer/company.json

Supplier list (metadata)

The API provides methods for accessing supplier metadata.

The supplier ID is the unique ITscope number of the distributor.

  1. company/distributor/company.xml: list of all suppliers in XML format
  2. company/distributor/company.json: list of all suppliers in JSON format

for example:
https://api.itscope.com/2.1/company/distributor/company.xml
or
https://api.itscope.com/2.1/company/distributor/company.json

Sample in XML-Format:

<companies>
  ...  
  <company>
    <name>ALSO Belgium BV</name>
    <street>Schaliënhoevedreef 20e</street>
    <zip>2800 </zip>
    <city>Mechelen</city>
    <country>BEL</country>
    <supplier>
      <id>10000940</id>
      <name>ALSO Belgique</name>
      <deeplink>https://www.itscope.com/red/app#companies/page/aeivP1_IThamCfPL7jrpgA/-</deeplink>
      <customerAccountNumber>1234</customerAccountNumber>
      <weeeRegNo>DE 1234</weeeRegNo>
    </supplier>
  </company>
 ...
</companies>

List of all suppliers with additionally available eServices, the respective eService features and the order conditions

The company/distributor/eservices endpoint can be used to query a list of all distributors with additional information on the available/established eServices and order conditions. The result can be queried both as XML and as JSON, e.g. https://api.itscope.com/2.1/company/distributor/eservices.xml

Overview of order conditions

If my own company has overwritten the supplier’s default values, these are also displayed in the order conditions. If my company has not overwritten the supplier’s default values, these are displayed.

NameDatAtypEDescription
partialDeliveryAvailableBooleanIf the supplier offers a partial delivery
partialDeliveryConfiguredBooleanHas a partial delivery been activated by my company for the supplier
ownDeliveryNoteAvailableBooleanIf the supplier offers shipping with its own delivery note
ownDeliveryNoteConfiguredBooleanHas shipping been activated with my company’s own delivery note for the supplier
orderOnlyValidItemIdsBooleanOnly items that are available in ITscope may be ordered, or are item numbers that ITscope does not recognize also permitted
absoluteShippingCostsDoubleAbsolute shipping costs – The net shipping costs (without weight/size-dependent surcharges) incurred for standard shipping
relativeShippingCostsDoublePercentage of shipping costs – Percentage value of the net order total for the shipping costs
freightFreeLimitDoubleFreight free limit – Net amount above which no shipping costs apply. Other insurances and flat rates are not affected
lowQuantitySurchargeDoubleLow quantity surcharge – Additional costs if the low quantity threshold is not reached
lowQuantitySurchargeThresholdDoubleLow quantity surcharge threshold – Amount up to which a low quantity surcharge will be charged
ownDeliveryNoteCostsDoubleAdditional costs if shipping with own delivery note is used
absoluteTransportInsuranceDoubleAbsolute amount for the transport insurance
relativeTransportInsuranceDoublePercentage of net order amount for transport insurance
environmentalFeeDoubleEnvironmental fee rate for each order
tollChargesDoubleToll charges rate for each order
packagingFeeDoublePackaging fee rate for each order

Values of the “features” field for eServices

The supported features from the eservice of the distributor are listed under the field supplier -> eservices -> features. Each feature is assigned to a type

  • general
    • EDI The distributor is connected via an electronic ordering interface
    • TRACKINGID The distributor provides tracking information in its delivery notes
    • SERIALNUMBER The distributor provides tracking information in its delivery notes
  • shippingMethod
    • Values for this can be standard, express, express8, express10, express12, pickup, consignment, expressSaturday10, expressSaturday12. These values can be specified in the OpenTrans document as the “type” attribute of the ORDER element to select this shipping method.
  • deliveryDateType
    • Both values can be specified as a type for the DELIVERY_DATE of an order item in the OpenTrans ORDER order.
      • fixed The distributor supports delivery on a fixed delivery date.
      • optional The distributor supports optional delivery dates.

Sample of the eservice output in JSON-Format

...  
   {
      "name": "ALSO Deutschland GmbH",
      "street": "Lange Wende 43",
      "zip": "59494",
      "city": "Soest",
      "country": "DEU",
      "manufacturer": {
        "id": "13910",
        "name": "ALSO Deutschland GmbH",
        "shortName": "ALSO Deutschland",
        "deeplink": "https://www.itscope.com/red/app#companies/page/NFLZPv_UEeC4CQAbIT6RAg/-"
      },
      "supplier": {
        "id": "10000142",
        "name": "ALSO Deutschland",
        "deeplink": "https://www.itscope.com/red/app#companies/page/NFLZPv_UEeC4CQAbIT6RAg/-",
        "customerAccountNumber": "10374599",
        "partialDeliveryAvailable": "true",
        "partialDeliveryConfigured": "true",
        "ownDeliveryNoteAvailable": "true",
        "ownDeliveryNoteConfigured": "false",
        "orderOnlyValidItemIds": "false",
        "absoluteShippingCosts": "8.4",
        "relativeShippingCosts": "0.0",
        "freightFreeLimit": "0.0",
        "lowQuantitySurcharge": "0.0",
        "lowQuantitySurchargeThreshold": "0.0",
        "ownDeliveryNoteCosts": "0.0",
        "absoluteTransportInsurance": "50.0",
        "relativeTransportInsurance": "1.0",
        "environmentalFee": "2.0",
        "tollCharges": "0.0",
        "packagingFee": "15.0",
        "eservices": [
          ...
          {
            "id": "16",
            "name": "Bestellung",
            "status": "ACTIVE",
            "lastVerificationDate": "2019-04-26T13:36:17+02:00",
            "lastVerificationInfo": "Der Abruf der Daten war erfolgreich.",
            "features": [
                {
                   "name": "express10",
                   "type": "shippingMethod"
                },
                {
                   "name": "express12",
                   "type": "shippingMethod"
                },
                {
                   "name": "expressSaturday12",
                   "type": "shippingMethod"
                },
                {
                   "name": "optional",
                   "type": "deliveryDateType"
                },
                {
                   "name": "TRACKINGID",
                   "type": "general"
                },
                {
                   "name": "SERIALNUMBER",
                   "type": "general"
                },
                {
                    "name": "EDI",
                    "type": "general"
                } 
             ]
          },
          ...
        ]
      }
    },
...
Was this article helpful?
Dislike 0
Views: 227