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 supplier is assigned to a company.
| Name | Compulsory field | Data type | Description |
|---|---|---|---|
| name | Yes | String (255) | Name of the company |
| street | String (255) | Street of the company | |
| zip | String (10) | Zip code of the company | |
| city | String (255) | City of the company | |
| country | String (3) | Country of the company in ISO Alpha-3 Country Code format | |
| manufacturer | manufacturer | Reference to the manufacturer object; only available if this company is a manufacturer | |
| supplier | supplier | Reference to the supplier object; only available if this company is a supplier |
manufacturer – list of manufacturers
Details about the API call for metadata can be found in the company metadata method article.
Manufacturer of a product.
| Name | Compulsory field | Data type | Description |
|---|---|---|---|
| id | Yes | Long | Unique key |
| name | Yes | String (255) | Manufacturer identifier |
| shortName | Yes | String (255) | Manufacturer shortened name |
| deeplink | Yes | String (2048) | URL, link to the manufacturer page on the ITscope platform |
supplier- list of suppliers
Details about the API call for metadata can be found in the company metadata method article.
Supplier of a source of supply.
| Name | Compulsory field | Data type | Description |
|---|---|---|---|
| id | Yes | Long | Unique key |
| name | Yes | String (255) | Supplier identifier |
| deeplink | Yes | String (2048) | URL, link to the supplier page on the ITscope platform |
| customerAccountNumber | String (255) | Customer number in case of partnership. Can be used as a filter to determine if there is a partnership with this supplier | |
| orderAccountNumber | String (255) | 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. | |
| weeeRegNo | String (12) | 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. |
productType – list of product types
Details about the API call for metadata can be found in the products/producttypes metadata method article.
Type of product, e.g. server or processor.
| Name | Compulsory field | Data type | Description |
|---|---|---|---|
| id | Yes | Long | Unique key |
| productTypeGroup | Yes | productTypeGroup (3) | Reference to product type group (ProductTypeGroup.id, n:1) |
| name | Yes | String (255) | Identifier of the product type. Can be used as a 2nd category level. |
| attributeTypeId1 | Long | Unambiguous attribute key to build a possible subcategory, points 1:n to AttributeCluster.attributeTypeId | |
| attributeTypeName1 | String (255) | Identifier of the attribute to build up a possible subcategory | |
| attributeTypeId2 | Long | Unambiguous Attribute Key to build a possible subcategory, points 1:n to AttributeCluster.attributeTypeId | |
| attributeTypeName2 | String (255) | Identifier of the attribute to build up a possible subcategory | |
| attributeTypeId3 | Long | Unambiguous attribute key to build a possible subcategory, points 1:n to AttributeCluster.attributeTypeId | |
| attributeTypeName3 | String (255) | Identifier of the attribute to build up a possible subcategory | |
| attributeTypeId4 | Long | Unambiguous Attribute Key to build a possible subcategory, points 1:n to AttributeCluster.attributeTypeId | |
| attributeTypeName4 | String (255) | Identifier of the attribute to build up a possible subcategory | |
| attributeTypeId5 | Long | Unambiguous Attribute Key to build a possible subcategory, points 1:n to AttributeCluster.attributeTypeId | |
| attributeTypeName5 | String (255) | Identifier of the attribute to build up a possible subcategory | |
| attributeType | attributeType | Reference to attributeType table |
attributeType
Specific characteristics of product properties.
| Name | Compulsory field | Data type | Description |
|---|---|---|---|
| id | Long | Unique identifier of a specific property type | |
| name | String (255) | Name of the specific property type | |
| rank | Long | Ranking of the property type, e.g. this can be used for sorting | |
| type | Integer | Data type of the property type | |
| attributeUnit | attributeUnit | Reference to attributeUnit table | |
| groupId | Long | Identifier of a property group, not a table reference, but uniquely identifies attributeTypeGroupName | |
| groupName | String (255) | Name of the property group |
attributeUnit
Units of all characteristics.
| Name | Compulsory field | Data type | Description |
|---|---|---|---|
| id | String (100) | Unique identifier of a unit | |
| baseUnitId | String (100) | The base unit of the unit | |
| mFactor | Long | Multiplication factor for conversion of the base unit into the unit | |
| divFactor | Long | Divisor for conversion of the base unit into the unit |
productTypeGroup
Details about the API call for metadata can be found in the products/producttypes metadata method article.
Product type grouping.
| Name | Compulsory field | Data type | Description |
|---|---|---|---|
| id | Yes | String (3) | Unique key |
| name | Yes | String (255) | Name of the group of product types, e.g. network technology. Can be used as a 1st category level. |