{"id":2102,"date":"2020-09-23T13:22:19","date_gmt":"2020-09-23T13:22:19","guid":{"rendered":"https:\/\/support.itscope.hostpress.me\/?post_type=kb&p=2102"},"modified":"2025-09-24T19:21:47","modified_gmt":"2025-09-24T17:21:47","slug":"format-description-for-metadata","status":"publish","type":"kb","link":"https:\/\/guide.itscope.com\/en\/kb\/format-description-for-metadata\/","title":{"rendered":"Format description for metadata"},"content":{"rendered":"\n

Metadata is available in XML and JSON output formats<\/a>.
<\/p>\n\n\n\n

company – list of companies<\/h2>\n\n\n\n

Details about the API call for metadata can be found in the company metadata method<\/a> article.<\/p>\n\n\n\n

Each manufacturer or supplier is assigned to a company.<\/p>\n\n\n\n

Name<\/th>Compulsory field<\/th>Data type<\/th>Description<\/th><\/tr><\/thead>
name<\/td> Yes<\/td>String (255)<\/td>Name of the company<\/td><\/tr>
street<\/td><\/td>String (255)<\/td>Street of the company<\/td><\/tr>
zip<\/td><\/td>String (10)<\/td>Zip code of the company<\/td><\/tr>
city<\/td><\/td>String (255)<\/td>City of the company<\/td><\/tr>
country<\/td><\/td>String (3)<\/td>Country of the company in ISO Alpha-3 Country Code<\/a> format<\/td><\/tr>
manufacturer<\/td> <\/td>manufacturer<\/td>Reference to the manufacturer object; only available if this company is a manufacturer<\/td><\/tr>
supplier<\/td> <\/td>supplier<\/td>Reference to the supplier object; only available if this company is a supplier<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

manufacturer – list of manufacturers<\/h2>\n\n\n\n

Details about the API call for metadata can be found in the company metadata method<\/a> article.<\/p>\n\n\n\n

Manufacturer of a product.<\/p>\n\n\n\n

Name<\/th>Compulsory field<\/th>Data type<\/th>Description<\/th><\/tr><\/thead>
id<\/td>Yes<\/td>Long<\/td>Unique key<\/td><\/tr>
name<\/td>Yes<\/td>String (255)<\/td>Manufacturer identifier<\/td><\/tr>
shortName<\/td>Yes<\/td>String (255)<\/td>Manufacturer shortened name<\/td><\/tr>
deeplink<\/td>Yes<\/td>String (2048)<\/td>URL, link to the manufacturer page on the ITscope platform<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

supplier- list of suppliers<\/h2>\n\n\n\n

Details about the API call for metadata can be found in the company metadata method<\/a> article.<\/p>\n\n\n\n

Supplier of a source of supply.<\/p>\n\n\n\n

Name<\/th>Compulsory field<\/th>Data type<\/th>Description<\/th><\/tr><\/thead>
id<\/td>Yes<\/td>Long<\/td>Unique key<\/td><\/tr>
name<\/td>Yes<\/td>String (255)<\/td>Supplier identifier<\/td><\/tr>
deeplink<\/td>Yes<\/td>String (2048)<\/td>URL, link to the supplier page on the ITscope platform<\/td><\/tr>
customerAccountNumber<\/td> <\/td>String (255)<\/td>Customer number in case of partnership. Can be used as a filter to determine if there is a partnership with this supplier<\/td><\/tr>
orderAccountNumber<\/td><\/td>String (255)<\/td>Order customer number for the API, this value can differ from the customer account number for specific suppliers (e.g. Ingram). If not available, the customer number is returned.<\/td><\/tr>
weeeRegNo<\/td><\/td>String (12)<\/td>WEEE number, is considered as proof of the registration of the manufacturer, the brand and the type of electrical or electronic equipment carried out in the country of manufacture.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

productType – list of product types<\/h2>\n\n\n\n

Details about the API call for metadata can be found in the products\/producttypes metadata method<\/a> article.<\/p>\n\n\n\n

Type of product, e.g. server or processor.<\/p>\n\n\n\n

Name<\/th>Compulsory field<\/th>Data type<\/th>Description<\/th><\/tr><\/thead>
id<\/td>Yes<\/td>Long<\/td>Unique key<\/td><\/tr>
productTypeGroup<\/td>Yes<\/td>productTypeGroup (3)<\/td>Reference to product type group (ProductTypeGroup.id, n:1)<\/td><\/tr>
name<\/td>Yes<\/td>String (255)<\/td>Identifier of the product type. Can be used as a 2nd category level<\/a>.<\/td><\/tr>
attributeTypeId1<\/td> <\/td>Long<\/td>Unambiguous attribute key to build a possible subcategory, points 1:n to AttributeCluster.attributeTypeId<\/td><\/tr>
attributeTypeName1<\/td> <\/td>String (255)<\/td>Identifier of the attribute to build up a possible subcategory<\/td><\/tr>
attributeTypeId2<\/td> <\/td>Long<\/td>Unambiguous Attribute Key to build a possible subcategory, points 1:n to AttributeCluster.attributeTypeId<\/td><\/tr>
attributeTypeName2<\/td> <\/td>String (255)<\/td>Identifier of the attribute to build up a possible subcategory<\/td><\/tr>
attributeTypeId3<\/td> <\/td>Long<\/td>Unambiguous attribute key to build a possible subcategory, points 1:n to AttributeCluster.attributeTypeId<\/td><\/tr>
attributeTypeName3<\/td> <\/td>String (255)<\/td>Identifier of the attribute to build up a possible subcategory<\/td><\/tr>
attributeTypeId4<\/td> <\/td>Long<\/td>Unambiguous Attribute Key to build a possible subcategory, points 1:n to AttributeCluster.attributeTypeId<\/td><\/tr>
attributeTypeName4<\/td> <\/td>String (255)<\/td>Identifier of the attribute to build up a possible subcategory<\/td><\/tr>
attributeTypeId5<\/td> <\/td>Long<\/td>Unambiguous Attribute Key to build a possible subcategory, points 1:n to AttributeCluster.attributeTypeId<\/td><\/tr>
attributeTypeName5<\/td> <\/td>String (255)<\/td>Identifier of the attribute to build up a possible subcategory<\/td><\/tr>
attributeType<\/td> <\/td>attributeType<\/td>Reference to attributeType table<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

attributeType<\/h2>\n\n\n\n

Specific characteristics of product properties.<\/p>\n\n\n\n

Name<\/th>Compulsory field<\/th>Data type<\/th>Description<\/th><\/tr><\/thead>
id<\/td> <\/td>Long<\/td>Unique identifier of a specific property type<\/td><\/tr>
name<\/td> <\/td>String (255)<\/td>Name of the specific property type<\/td><\/tr>
rank<\/td> <\/td>Long<\/td>Ranking of the property type, e.g. this can be used for sorting<\/td><\/tr>
type<\/td> <\/td>Integer<\/td>Data type<\/a> of the property type<\/td><\/tr>
attributeUnit<\/td> <\/td>attributeUnit<\/td>Reference to attributeUnit table<\/td><\/tr>
groupId<\/td> <\/td>Long<\/td>Identifier of a property group, not a table reference, but uniquely identifies attributeTypeGroupName<\/td><\/tr>
groupName<\/td> <\/td>String (255)<\/td>Name of the property group<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

attributeUnit<\/h2>\n\n\n\n

Units of all characteristics.<\/p>\n\n\n\n

Name<\/th>Compulsory field<\/th>Data type<\/th>Description<\/th><\/tr><\/thead>
id<\/td> <\/td>String (100)<\/td>Unique identifier of a unit<\/td><\/tr>
baseUnitId<\/td> <\/td>String (100)<\/td>The base unit<\/a> of the unit<\/td><\/tr>
mFactor<\/td> <\/td>Long<\/td>Multiplication factor for conversion of the base unit into the unit<\/td><\/tr>
divFactor<\/td> <\/td>Long<\/td>Divisor for conversion of the base unit into the unit<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

productTypeGroup<\/h2>\n\n\n\n

Details about the API call for metadata can be found in the products\/producttypes metadata method<\/a> article.<\/p>\n\n\n\n

Product type grouping.<\/p>\n\n\n\n

Name<\/th>Compulsory field<\/th>Data type<\/th>Description<\/th><\/tr><\/thead>
id<\/td>Yes<\/td>String (3)<\/td>Unique key<\/td><\/tr>
name<\/td>Yes<\/td>String (255)<\/td>Name of the group of product types, e.g. network technology. Can be used as a 1st category level<\/a>.<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"

Metadata is available in XML and JSON output formats. company – list of companies Details about the API call for metadata can be found in the company metadata method article. Each manufacturer or …<\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"kbtopic":[173],"kbtag":[],"class_list":["post-2102","kb","type-kb","status-publish","hentry","kbtopic-api-export-output-formats-business-data-metadata"],"_links":{"self":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/2102","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=2102"}],"version-history":[{"count":7,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/2102\/revisions"}],"predecessor-version":[{"id":19317,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/2102\/revisions\/19317"}],"wp:attachment":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/media?parent=2102"}],"wp:term":[{"taxonomy":"kbtopic","embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kbtopic?post=2102"},{"taxonomy":"kbtag","embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kbtag?post=2102"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}