{"id":1898,"date":"2020-09-22T13:46:10","date_gmt":"2020-09-22T13:46:10","guid":{"rendered":"https:\/\/support.itscope.hostpress.me\/?post_type=kb&#038;p=1898"},"modified":"2025-11-11T17:06:25","modified_gmt":"2025-11-11T15:06:25","slug":"company-metadata-methods","status":"publish","type":"kb","link":"https:\/\/guide.itscope.com\/en\/kb\/company-metadata-methods\/","title":{"rendered":"company metadata methods"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\">Manufacturer list (metadata)<\/h2>\n\n\n\n<p>The API provides methods for accessing <a href=\"https:\/\/guide.itscope.com\/en\/kb\/format-description-for-metadata\/\">manufacturer metadata<\/a>.<\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li>manufacturer\/company.xml: list of all manufacturers in XML format<\/li>\n\n\n\n<li>manufacturer\/company.json: list of all manufacturers in the JSON format<\/li>\n<\/ol>\n\n\n\n<p>for example:<br><a href=\"https:\/\/api.itscope.com\/2.1\/company\/manufacturer\/company.xml\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/api.itscope.com\/2.1\/company\/manufacturer\/company.xml<\/a><br>or<br><a href=\"https:\/\/api.itscope.com\/2.1\/company\/manufacturer\/company.json\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/api.itscope.com\/2.1\/company\/manufacturer\/company.json<\/a><\/p>\n\n\n\n<p><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Supplier list (metadata)<\/h2>\n\n\n\n<p>The API provides methods for accessing <a href=\"https:\/\/guide.itscope.com\/en\/kb\/format-description-for-metadata\/\">supplier metadata<\/a>.<\/p>\n\n\n\n<p>The <strong>supplier ID<\/strong> is the unique ITscope number of the distributor.<\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li>company\/distributor\/company.xml: list of all suppliers in XML format<\/li>\n\n\n\n<li>company\/distributor\/company.json: list of all suppliers in JSON format<\/li>\n<\/ol>\n\n\n\n<p>for example:<br><a href=\"https:\/\/api.itscope.com\/2.1\/company\/distributor\/company.xml\" target=\"_blank\" rel=\"noreferrer noopener\"><em>https:\/\/api.itscope.com\/2.1\/company\/distributor\/company.xml<\/em><\/a><br>or<br><a href=\"https:\/\/api.itscope.com\/2.1\/company\/distributor\/company.json\" target=\"_blank\" rel=\"noreferrer noopener\"><em>https:\/\/api.itscope.com\/2.1\/company\/distributor\/company.json<\/em><\/a><\/p>\n\n\n\n<p>Sample in XML-Format:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>&lt;companies>\n  ...  \n  &lt;company>\n    &lt;name>ALSO Belgium BV&lt;\/name>\n    &lt;street>Schali\u00ebnhoevedreef 20e&lt;\/street>\n    &lt;zip>2800 &lt;\/zip>\n    &lt;city>Mechelen&lt;\/city>\n    &lt;country>BEL&lt;\/country>\n    &lt;supplier>\n      &lt;id>10000940&lt;\/id>\n      &lt;name>ALSO Belgique&lt;\/name>\n      &lt;deeplink>https:\/\/www.itscope.com\/red\/app#companies\/page\/aeivP1_IThamCfPL7jrpgA\/-&lt;\/deeplink>\n      &lt;customerAccountNumber>123456&lt;\/customerAccountNumber>\n      &lt;orderAccountNumber>DE123456&lt;\/orderAccountNumber>\n      &lt;weeeRegNo>DE 1234&lt;\/weeeRegNo>\n    &lt;\/supplier>\n  &lt;\/company>\n ...\n&lt;\/companies><\/code><\/pre>\n\n\n\n<p>The <strong>customerAccountNumber <\/strong>field contains the customer number that you have stored for the supplier in ITscope.<\/p>\n\n\n\n<p>The <strong>orderAccountNumber <\/strong>field contains the customer number in the format required for transmission when placing supplier orders via the ITscope API. For some suppliers (such as Ingram), this is generated from the customer number.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">List of all suppliers with additionally available eServices, the respective eService features and the order conditions<\/h3>\n\n\n\n<p>The company\/distributor\/eservices endpoint can be used to query a list of all distributors with additional information on the available\/established<a href=\"https:\/\/guide.itscope.com\/en\/kb\/setting-up-supplier-accounts\/\"> eServices<\/a> and <a href=\"https:\/\/guide.itscope.com\/en\/kb\/orderingconditions-2\/\">order conditions<\/a>. The result can be queried both as XML and as JSON, e.g. <a href=\"https:\/\/api.itscope.com\/2.1\/company\/distributor\/eservices.xml\"><em>https:\/\/api.itscope.com\/2.1\/company\/distributor\/<\/em>eservices.xml<\/a><\/p>\n\n\n\n<h4 class=\"wp-block-heading\">Overview of order conditions<\/h4>\n\n\n\n<p>If my own company has overwritten the supplier&#8217;s default values, these are also displayed in the <a href=\"https:\/\/guide.itscope.com\/en\/kb\/orderingconditions-2\/\">order conditions<\/a>. If my company has not overwritten the supplier&#8217;s default values, these are displayed.<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th>Name<\/th><th>DatAtypE<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>partialDeliveryAvailable<\/td><td>Boolean<\/td><td>If the supplier offers a partial delivery<\/td><\/tr><tr><td>partialDeliveryConfigured<\/td><td>Boolean<\/td><td>Has a partial delivery been activated by my company for the supplier<\/td><\/tr><tr><td>ownDeliveryNoteAvailable<\/td><td>Boolean<\/td><td>If the supplier offers shipping with its own delivery note<\/td><\/tr><tr><td>ownDeliveryNoteConfigured<\/td><td>Boolean<\/td><td>Has shipping been activated with my company&#8217;s own delivery note for the supplier<\/td><\/tr><tr><td>orderOnlyValidItemIds<\/td><td>Boolean<\/td><td>Only items that are available in ITscope may be ordered, or are item numbers that ITscope does not recognize also permitted<\/td><\/tr><tr><td>absoluteShippingCosts<\/td><td>Double<\/td><td>Absolute shipping costs &#8211; The net shipping costs (without weight\/size-dependent surcharges) incurred for standard shipping<\/td><\/tr><tr><td>relativeShippingCosts<\/td><td>Double<\/td><td>Percentage of shipping costs &#8211; Percentage value of the net order total for the shipping costs<\/td><\/tr><tr><td>freightFreeLimit<\/td><td>Double<\/td><td>Freight free limit &#8211; Net amount above which no shipping costs apply. Other insurances and flat rates are not affected<\/td><\/tr><tr><td>lowQuantitySurcharge<\/td><td>Double<\/td><td>Low quantity surcharge &#8211; Additional costs if the low quantity threshold is not reached<\/td><\/tr><tr><td>lowQuantitySurchargeThreshold<\/td><td>Double<\/td><td>Low quantity surcharge threshold &#8211; Amount up to which a low quantity surcharge will be charged<\/td><\/tr><tr><td>ownDeliveryNoteCosts<\/td><td>Double<\/td><td>Additional costs if shipping with own delivery note is used<\/td><\/tr><tr><td>absoluteTransportInsurance<\/td><td>Double<\/td><td>Absolute amount for the transport insurance<\/td><\/tr><tr><td>relativeTransportInsurance<\/td><td>Double<\/td><td>Percentage of net order amount for transport insurance<\/td><\/tr><tr><td>environmentalFee<\/td><td>Double<\/td><td>Environmental fee rate for each order<\/td><\/tr><tr><td>tollCharges<\/td><td>Double<\/td><td>Toll charges rate for each order<\/td><\/tr><tr><td>packagingFee<\/td><td>Double<\/td><td>Packaging fee rate for each order<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\">Values of the \u201cfeatures\u201d field for eServices<\/h4>\n\n\n\n<p>The supported <a href=\"https:\/\/guide.itscope.com\/en\/kb\/setting-up-supplier-accounts\/\">features from the eservice<\/a> of the distributor are listed under the field supplier -&gt; eservices -&gt; features. Each feature is assigned to a type<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>general<\/strong>\n<ul class=\"wp-block-list\">\n<li><strong>EDI<\/strong> The distributor is connected via an electronic ordering interface<\/li>\n\n\n\n<li><strong>TRACKINGID<\/strong> The distributor provides tracking information in its delivery notes<\/li>\n\n\n\n<li><strong>SERIALNUMBER<\/strong> The distributor provides tracking information in its delivery notes<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li><strong>shippingMethod<\/strong> \n<ul class=\"wp-block-list\">\n<li>Values for this can be <strong>standard<\/strong>, <strong>express<\/strong>, <strong>express8<\/strong>, <strong>express10<\/strong>, <strong>express12<\/strong>, <strong>pickup<\/strong>, <strong>consignment<\/strong>, <strong>expressSaturday10<\/strong>, <strong>expressSaturday12<\/strong>. These values can be specified in the OpenTrans document as the \u201ctype\u201d attribute of the ORDER element to select this shipping method.<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li><strong>deliveryDateType<\/strong> \n<ul class=\"wp-block-list\">\n<li>Both values can be specified as a type for the DELIVERY_DATE of an order item in the OpenTrans ORDER order.\n<ul class=\"wp-block-list\">\n<li><strong>fixed<\/strong> The distributor supports delivery on a fixed delivery date.<\/li>\n\n\n\n<li><strong>optional<\/strong> The distributor supports optional delivery dates.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n<h4 class=\"wp-block-heading\">Sample of the eservice output in JSON-Format<\/h4>\n\n\n\n<pre class=\"wp-block-code\"><code>...  \n   {\n      \"name\": \"ALSO Deutschland GmbH\",\n      \"street\": \"Lange Wende 43\",\n      \"zip\": \"59494\",\n      \"city\": \"Soest\",\n      \"country\": \"DEU\",\n      \"manufacturer\": {\n        \"id\": \"13910\",\n        \"name\": \"ALSO Deutschland GmbH\",\n        \"shortName\": \"ALSO Deutschland\",\n        \"deeplink\": \"https:\/\/www.itscope.com\/red\/app#companies\/page\/NFLZPv_UEeC4CQAbIT6RAg\/-\"\n      },\n      \"supplier\": {\n        \"id\": \"10000142\",\n        \"name\": \"ALSO Deutschland\",\n        \"deeplink\": \"https:\/\/www.itscope.com\/red\/app#companies\/page\/NFLZPv_UEeC4CQAbIT6RAg\/-\",\n        \"customerAccountNumber\": \"123456\",\n        \"orderAccountNumber\": \"DE123456\",\n        \"partialDeliveryAvailable\": \"true\",\n        \"partialDeliveryConfigured\": \"true\",\n        \"ownDeliveryNoteAvailable\": \"true\",\n        \"ownDeliveryNoteConfigured\": \"false\",\n        \"orderOnlyValidItemIds\": \"false\",\n        \"absoluteShippingCosts\": \"8.4\",\n        \"relativeShippingCosts\": \"0.0\",\n        \"freightFreeLimit\": \"0.0\",\n        \"lowQuantitySurcharge\": \"0.0\",\n        \"lowQuantitySurchargeThreshold\": \"0.0\",\n        \"ownDeliveryNoteCosts\": \"0.0\",\n        \"absoluteTransportInsurance\": \"50.0\",\n        \"relativeTransportInsurance\": \"1.0\",\n        \"environmentalFee\": \"2.0\",\n        \"tollCharges\": \"0.0\",\n        \"packagingFee\": \"15.0\",\n        \"eservices\": &#91;\n          ...\n          {\n            \"id\": \"16\",\n            \"name\": \"Bestellung\",\n            \"status\": \"ACTIVE\",\n            \"lastVerificationDate\": \"2019-04-26T13:36:17+02:00\",\n            \"lastVerificationInfo\": \"Der Abruf der Daten war erfolgreich.\",\n            \"features\": &#91;\n                {\n                   \"name\": \"express10\",\n                   \"type\": \"shippingMethod\"\n                },\n                {\n                   \"name\": \"express12\",\n                   \"type\": \"shippingMethod\"\n                },\n                {\n                   \"name\": \"expressSaturday12\",\n                   \"type\": \"shippingMethod\"\n                },\n                {\n                   \"name\": \"optional\",\n                   \"type\": \"deliveryDateType\"\n                },\n                {\n                   \"name\": \"TRACKINGID\",\n                   \"type\": \"general\"\n                },\n                {\n                   \"name\": \"SERIALNUMBER\",\n                   \"type\": \"general\"\n                },\n                {\n                    \"name\": \"EDI\",\n                    \"type\": \"general\"\n                } \n             ]\n          },\n          ...\n        ]\n      }\n    },\n...<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"<p>Manufacturer list (metadata) The API provides methods for accessing manufacturer metadata. for example:https:\/\/api.itscope.com\/2.1\/company\/manufacturer\/company.xmlorhttps:\/\/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 &#8230;<\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"kbtopic":[182],"kbtag":[],"class_list":["post-1898","kb","type-kb","status-publish","hentry","kbtopic-api-methods-products-metadata"],"_links":{"self":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/1898","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb"}],"about":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/types\/kb"}],"author":[{"embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/comments?post=1898"}],"version-history":[{"count":8,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/1898\/revisions"}],"predecessor-version":[{"id":19589,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/1898\/revisions\/19589"}],"wp:attachment":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/media?parent=1898"}],"wp:term":[{"taxonomy":"kbtopic","embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kbtopic?post=1898"},{"taxonomy":"kbtag","embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kbtag?post=1898"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}