Format description for product data format standard

Last modified: 11. November 2022

Database diagram

Dependency diagram for the CSV output format, including SQL scripts for generating the tables and to load the data with load data local infile at the end of this article.

Overview of data format elements

In CSV output format, these elements are files, in XML or JSON output format these are nodes.

The data format standard consists of the following elements:

  • product: product from the ITscope catalogue.
  • supplierItem: source of supply for an ITscope product. A specific product offering from a distributor listed on ITscope.
  • project: price, availability and further information on a project item.
  • attribute: properties of a product.
  • attributeCluster: property clusters in which the product can be found for feature searches. Can summarise several property expressions in intervals, according to the quantity, e.g. 64-128 MB RAM.
  • accessory: original accessories and compatible accessories for a product.

Elements marked with a globe vary depending on the selected export language:

Dieses Bild hat ein leeres Alt-Attribut. Der Dateiname ist globus-1.png

product

Product from the ITscope catalogue.

NameCompulsory fieldData typeDescription
puidYeslongUnique key
ean String (18)EAN
manufacturerSKU String (40)Manufacturer article number
icecatId String (255)Icecat ID
cnetId String (255)1WorldSync ID (formerly CNET)
bechlemId String (255)Bechlem ID
eClass String (255)eClass ID Version 5.1.2
manufacturerIdYeslongReference to the manufacturer of this product (n:1 on Manufacturer.id)
manufacturerName String (255)Name of the manufacturer
productNameWithManufacturerYesStringProduct name, including manufacturer name
shortDescription StringShort description for the product
longDescription StringLong description for the product
productTypeIdYeslongReference to the product type of this product
productTypeGroupIdYesString (3)Reference to product type group (ProductTypeGroup.id, n:1)
productTypeGroupNameYesString (255)Name of the group of product types, e.g. network technology. Can be used as 1st category level.
productTypeNameYesString (255)Identifier for the product type. Can be used as 2nd category level.
attributeTypeId1 longUnambiguous attribute key to build a possible subcategory, points to 1:n on AttributeCluster.attributeTypeId
attributeTypeName1 String (255)Identifier of the attribute to build up a possible subcategory
attributeTypeId2 longUnambiguous Attribute Key to build a possible subcategory, points to 1:n on AttributeCluster.attributeTypeId
attributeTypeName2 String (255)Identifier of the attribute to build up a possible subcategory
attributeTypeId3 longUnambiguous Attribute Key to build a possible subcategory, points to 1:n on AttributeCluster.attributeTypeId
attributeTypeName3 String (255)Identifier of the attribute to build up a possible subcategory
attributeTypeId4 longUnambiguous Attribute Key to build a possible subcategory, points to 1:n on AttributeCluster.attributeTypeId
attributeTypeName4 String (255)Identifier of the attribute to build up a possible subcategory
attributeTypeId5 longUnambiguous Attribute Key to build a possible subcategory, points to 1:n on AttributeCluster.attributeTypeId
attributeTypeName5 String (255)Identifier of the attribute to build up a possible subcategory
attributeValue1 String (1024)Attribute cluster value for the attribute from ProductType.attributeTypeId1. Can be used as a 3rd category level, if applicable.
attributeValue2 String (1024)Attribute cluster value for the attribute from ProductType.attributeTypeId2. Can be used as a 4th category level, if applicable.
attributeValue3 String (1024)Attribute cluster value for the attribute from ProductType.attributeTypeId3. Can be used as a 5th category level, if applicable.
attributeValue4 String (1024)Attribute cluster value for the attribute from ProductType.attributeTypeId4
attributeValue5 String (1024)Attribute cluster value for the attribute from ProductType.attributeTypeId5
productSubTypeId String (1024)ID of product sub type
productSubType String (1024)Design property of the product, e.g. mouse or keyboard for input devices. Should not be used as a 3rd category level.
productLineId longID of the product line
productLine String (1024)Product line
productModel String (1024)Product model identifier
estimateGrossWeight DoubleWeight in kilograms
largeDimX String (1024)Length of the product including unit of measurement
largeDimY String (1024)Height of the product including unit of measurement
largeDimZ String (1024)Width of product including unit of measurement
customsTariffNumber String (255)Customs tariff number
deeplinkYesString (2048)Deep link to the ITscope.com platform
standardHtmlDatasheetYesString (2048)URL, link to HTML standard datasheet
standardPdfDatasheet String (2048)URL, link to PDF standard datasheet
manufacturerSite String (1024)URL, link to manufacturer page
manufacturerDatasheet String (1024)URL, link to manufacturer datasheet
imageThumb String (1024)Preview of the best product image
imageThumbWidth IntegerWidth of the preview image in pixels
imageThumbHeight IntegerHeight of the preview image in pixels
image1 String (1024)Link to the best possible product image, in the largest version
imageWidth1 IntegerWidth of image in pixels
imageHeight1 IntegerHeight of the image in pixels
image2 String (1024)Link to another good product image, preferably including product packaging (never the same as the first image)
imageWidth2 IntegerWidth of the image in pixels
imageHeight2 IntegerHeight of the image in pixels
image3 String (1024)Link to the first image in the gallery (not one of the already listed images above)
imageWidth3 IntegerWidth of the image in pixels
imageHeight3 IntegerHeight of the image in pixels
image4 String (1024)Link to the second image in the gallery (not one of the already listed images above)
imageWidth4 IntegerWidth of the image in pixels
imageHeight4 IntegerHeight of the image in pixels
image5 String (1024)Link to the third image in the gallery (never one of the already listed)
imageWidth5 IntegerWidth of the image in pixels
imageHeight5 IntegerHeight of the image in pixels
energyLabel String (1024)Link to the Energy Label image
entryDateYesDateSince when has the product been listed on the platform?
rank IntegerOverall popularity rank (rank 1 to n, a high number corresponds to a bad ranking)
qualification IntegerQualification of the product
warrantyText StringWarranty text for the product
marketingText StringMarketing text for the product
htmlSpecs StringTechnical properties of the product, in HTML format
recommendedRetailPriceNet DoubleManufacturer’s RRP
price BigDecimalPrice basis for the calculated price
priceCalc BigDecimalCalculated price, based on the individual price calculation
currencyCode String (3)Currency unit that applies to this price information
priceCalcVat BigDecimalSales tax rate that was used to determine the calculated price
priceLastUpdate DateTime of last update of price information
priceSupplierId longReference to a supplier (1:1) who has provided the source of supply with this price information
priceSupplierName String (255)Name of the supplier that provided this source of supply
priceSupplierItemId longReference to a source of supply (n:1); if this field is zero, then the price information refers to a product (source of supply reference and product reference are mutually exclusive)
priceSupplierSKU String (40)Product identifier given by the supplier that provided this source of supply
stockSupplierText String (40)Textual inventory information of the supplier, directly taken over, without interpretation
stockStatus IntegerNumeric key of the delivery status of the inventory information
stockStatusText String (255)Delivery status of inventory information, such as ‘in stock’ or ‘in field warehouse’
stock IntegerQuantity of products for the delivery status indicated in this structure
externalStock IntegerExternal stock (additional information provided by some suppliers in structures with ‘in stock’ delivery status)
incomingStock IntegerStock quantity that will be replenished (additional information provided by some suppliers in structures with ‘in stock’ delivery status)
stockAvailabilityDate DateDelivery date for products that are not in stock
stockLastUpdate DateTime of last update of inventory information
aggregatedStatusYesIntegerBest availability status
aggregatedStatusTextYesString (20)Best availability status
aggregatedStockYesintegerSum of all stock levels
aggregatedSupplierItemsYesIntegerSum of all distributors offering this product
supplierItemYesList <supplierItem>Source of supply of an ITscope product. A specific offer from a distributor listed on ITscope
attribute List <attribute>Properties of a product
attributeCluster List <attributeCluster>Property clusters in which the product can be found for feature searches. Can summarise several property expressions in intervals, according to the quantity, e.g. 64-128 MB RAM
accessory List <accessory>Original accessories and compatible accessories for a product

supplierItem

Source of supply for an ITscope product. A specific offering from a distributor listed on ITscope.

NameCompulsory fieldData typeDescription
idYeslongUnique key
ean String (18)EAN
manufacturerSKU String (40)Supplier’s part number (does not have to match ITscope)
supplierSKU String (40)Product number of the supplier
supplierIdYeslongRefers 1:1 to Supplier.id
supplierName String (255)Name of Supplier
manufacturerName String (80)Manufacturer name as specified by supplier
productName String (255)Exact identifier of the product, as given by the supplier
longDescription String (60000)Extended product description by the supplier
conditionIdYesIntegerNumerical code for the product condition
conditionNameYesString (255)Condition of the item (new, used, B-Stock, Refurbished, etc.)
eolProductYesBooleanNotice for discontinued products
matchQualityYesIntegerMapping quality of the product with the ITscope product catalogue
eanValidYesBooleanFlag to indicate whether the EAN of the suppler is valid according to the EAN criteria
specialOfferYesBooleanFlag to indicate if the item is on special offer
promotion String (40)Name of the promotion activity of the supplier
vat IntegerVAT rate for the item
copyrightLevy DoubleCopyright levy
customsTariffNumber String (50)Customs tariff number
countryOfOrigin String (20)Country of origin of the product
largeDimX DoubleLength of the product including unit of measurement
largeDimY DoubleHeight of the product including unit of measurement
largeDimZ doubleWidth of product including unit of measurement
warrantyText String (40)Supplier’s warranty
deeplink String (1024)Link to the product with the supplier
recommendedRetailPriceNet DoubleRRP indication from the supplier
priceYesBigDecimalPrice
priceCalcYesBigDecimalCalculated price, based on the individual price calculation
currencyCodeYesString (3)Currency unit that applies to this price information
priceCalcVatYesBigDecimalSales tax rate that was used to determine the calculated price
priceLastUpdateYesDateTime of last update of price information
stockSupplierText StringStock information on the source of supply, as given by the supplier
stockStatus IntegerNumeric key for the delivery status of the inventory information
stockStatusText String (255)Delivery status of inventory information, such as ‘in stock’ or ‘in field warehouse’
stock IntegerStock level
externalStock IntegerExternal stock (additional information provided by some suppliers in structures with ‘in stock’ delivery status)
incomingStock IntegerStock is being replenished (additional information provided by some suppliers in structures with ‘in stock’ delivery status)
stockAvailabilityDate DateDelivery date for products that are not in stock
lastStockUpdate DateTime of last update of inventory information

project

Price, availability and further information on a project agreement.

NameCompulsory fieldData typeDescription
supplierProjectId String (40)Project number of the supplier
manufacturerProjectIdYesString (40)Project number of the manufacturer (unique key)
projectName String (255)Project description
endCustomer String (255)End customer for the project item
priceYesBigDecimalProject price
validFrom DateDate the project conditions become valid
validTo DateDate the project conditions expire
targetQuantity IntegerNegotiated project amount
remainingQuantityYesIntegerRemaining quota that can be ordered
minQuantity IntegerMinimum ordering quantity
projectLastUpdate DateTime of last update of project information

attribute

Properties of a product.

NameCompulsory fieldData typeDescription
displayValue String (10000)The readable value of the property, including unit
attributeTypeId longUnique identifier of a concrete property type
attributeTypeName String (255)Name of the concrete property type
attributeTypeRank longRanking of the property type, for example, can be used for sorting
attributeTypeGroupId longIdentifier of a property group, no table reference, but uniquely identifies attributeTypeGroupName
attributeTypeGroupName String (255)Name of the property group

attributeCluster

Property clusters in which the product can be found for feature searches. Can summarise several property expressions in intervals, according to the quantity, e.g. 64-128 MB RAM.

NameCompulsory fieldData typeDescription
id longUnique ITscope Key
productTypeId longReference to the product type, optional
productTypeName String (255)Name of the product type to which this property belongs, optional
attributeTypeName String (255)Name of a property. Can be the same as the name from ProductType.attributeTypeName (1..5)
attributeTypeGroupName String (255)Name of a property group
name String (255)Identifier of the characteristic (e.g. 2 GB, 15″, 80 W – 120 W)
rank longRank of the property

accessory

Original accessories and compatible accessories for a product.

NameCompulsory fieldData typeDescription
referencedProductId longReference to a reference product, e.g. a product that is offered as an original accessory for another product
typeId IntegerInternal identifier for the type of the reference product
type String (255)Identifier for the type of the reference product, including original accessories, all compatible accessories, etc.

Database scripts for CSV

Was this article helpful?
Dislike 0
Views: 119