Please read the article on data formats and output formats first, to make sure that you want to use this particular data format.
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 developerUpdate consists of the following elements:
- product: product from the ITscope catalogue
- productPriceInfo: calculated price information for a product. This element is only present if a price can be selected and calculated from the pricing rules deposited on the platform by the supplier
- productStockInfo: availability information for the selected source of supply in productPriceInfo
- supplierItem: source of supply for an ITscope product. A specific product offering from a distributor listed on ITscope
- supplier: supplier for a source of supply
- supplierPriceInfo: price data for a source of supply. For each configured price source, a PriceInfo is stored, e.g. real-time, individual price list or generally available price list. For some suppliers, no generally available prices are listed. In this case, the supplierPriceInfo element is empty (if no individual price list has been configured)
- supplierStockInfo: availability information for the source of supply
- project: price, availability and further information on a project item.
Elements marked with a globe vary depending on the selected export language:
product
Product from the ITscope catalogue.
Name | Compulsory field | Data type | Description |
---|---|---|---|
puid | Yes | Long | Unique key |
productPriceInfo | productPriceInfo | Calculated price information for a product. This element is only present if a price can be selected and calculated from the pricing rules deposited on the platform by the supplier | |
productStockInfo | productStockInfo | Availability information for the selected source of supply in productPriceInfo | |
supplierItem | Yes | List <supplierItem> | Source of supply of an ITscope product. A specific offer from a distributor listed on ITscope |
productPriceInfo
Calculated price information for a product. Is only present if from the supplier deposited within the platform pricing rules, a product may be selected and calculated.
Name | Compulsory field | Data type | Description |
---|---|---|---|
price | Yes | BigDecimal | Price basis for the calculated price |
priceCalc | Yes | BigDecimal | Calculated price, based on the individual price calculation |
currencyCode | Yes | String (3) | Currency unit that applies to this price information |
priceCalcVat | Yes | BigDecimal | Sales tax rate that was used to determine the calculated price |
priceLastUpdate | Yes | Date | Time of last update of price information |
minScale | Yes | Integer | Scaled prices |
priceSourceId | Yes | Integer | Identifier for the source of the price information |
priceSourceName | String (255) | Readable text on the origin of the price information, e.g. ‘Individual price list’ | |
priceStatus | Yes | String (255) | Textual information on price retrieval, e.g. ‘The retrieval of the data was successful’ |
priceSupplierId | Yes | Long | Reference to the supplier (1:1) that provided the source of supply with this price information |
priceSupplierName | Yes | String (255) | Name of the supplier that provided this source of supply |
priceSupplierItemId | Yes | Long | Reference 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 | Yes | String (150) | Product identifier of the supplier that provided this source of supply [was String(40) before 18/10/2021] |
priceBillingPeriod | Integer | Length of the price billing period | |
priceBillingPeriodUnit | String (40) | Unit of the price billing period (e.g. “Years”, “Month”) | |
priceSubscriptionPeriod | Integer | Length of the price subscription period | |
priceSubscriptionPeriodUnit | String (40) | Unit of the price subscription period (e.g. “Years”, “Month”) |
productStockInfo
Availability information for the source of supply selected in productPriceInfo.
Name | Compulsory field | Data type | Description |
---|---|---|---|
stockSupplierText | String (40) | Textual stock information from the supplier, this is directly taken over without interpretation | |
stockStatus | Yes | Integer | Numeric key of the delivery status of the stock information |
stockStatusText | Yes | String (255) | Delivery status for this stock information, such as ‘in stock’ or ‘in field warehouse’ |
stock | Yes | Integer | Quantity available for the delivery status indicated in this structure |
externalStock | Integer | External stock (additional information provided by some suppliers in structures with ‘in stock’ delivery status) | |
incomingStock | Integer | Stock quantity that will be replenished (additional information provided by some suppliers in structures with ‘in stock’ delivery status) | |
stockAvailabilityDate | Date | Delivery date for products that are not in stock | |
stockLastUpdate | Yes | Date | Time of last update of stock information |
stockSourceId | Yes | Integer | Numeric key for the source of stock information |
stockSourceName | Yes | String (255) | Source of stock information, e.g. ‘Individual price list’ |
stockUnlimited | Yes | Boolean | Indicates whether the items of this stock information are available in an unlimited quantity |
supplierItem
Source of supply of an ITscope product. A specific product offering from a distributor listed on ITscope.
Name | Compulsory field | Data type | Description |
---|---|---|---|
id | Yes | long | Unique key |
supplierSKU | String (150) | Product number of the supplier [was String(40) before 18/10/2021] | |
supplier | Yes | supplier | Refers 1:1 to Supplier.id |
supplierPriceInfo | List <supplierPriceInfo> | Price data for a source of supply. For each configured price source, a PriceInfo is stored, e.g. Realtime, individual price list or generally available price list. For some vendors, no generally available prices are listed. In this case, the supplierPriceInfo is empty (if no own price list has been configured) | |
supplierStockInfo | List <supplierStockInfo> | Availability information for the source of supply | |
projects | List<project> | Projects for the source of supply | |
supplierPackagingInfo | supplierPackagingInfo | Information on the packaging units of a source of supply | |
scaledPriceInfo | List<scaledPriceInfo> | Information on scaled prices of a source of supply |
supplierPackageInfo
Information on packaging units of a source of supply. The unit codes for packaging units are in UN/ECE Recommendation No.21. This standard is recommended by UN/CEFACT. Details see UNECE.
Name | Mandatory | Data type | description |
---|---|---|---|
contentUnit | String (50) | Unit code of the contents of a package | |
intervalQuantity | | Integer | Number indicating in which graduation the item can be ordered (in order units). |
minQuantity | Integer | Minimum number of packaging units to trigger an order | |
numberContentUnitPerOrderUnit | Integer | Number of contents of a packaging unit | |
orderUnit | | String (50) | Packaging unit code |
priceQuantity | Integer | Number of packaging units for a given price | |
supplierPackingQuantity | Integer | Number of packaging units a supplier provides in a purchase order | |
totalPriceQuantity | | Integer | Total number of units (packaging units * contents) for a given price |
scaledPriceInfo
Information on scaled prices of a source of supply
Name | Mandatory | Data type | DESCRIPTION |
---|---|---|---|
scale | Yes | Integer | Indicates the scale from which the price applies |
price | Yes | BigDecimal | The price for the scale |
supplier
Supplier of a source of supply.
Name | Compulsory field | Data type | Description |
---|---|---|---|
id | Yes | long | Unique key |
name | Yes | String (255) | Identifier of the supplier |
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 | |
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. |
supplierPriceInfo
Price data for a source of supply. For each configured price source, a PriceInfo is stored, e.g. real-time, individual price list or generally available price list. For some suppliers, no generally available prices are listed. In this case, the supplierPriceInfo is empty (if no individual price list has been configured).
Name | Compulsory field | Data type | Description |
---|---|---|---|
price | Yes | BigDecimal | Price basis for the calculated price |
priceCalc | Yes | BigDecimal | Calculated price, based on the individual price calculation |
currencyCode | Yes | String (3) | Currency unit that applies to this price information |
priceCalcVat | Yes | BigDecimal | Sales tax rate that was used to determine the calculated price |
priceLastUpdate | Yes | Date | Time of last update of price information |
minScale | Yes | Integer | Scaled price |
priceSourceId | Yes | Integer | Identifier for the source of the price information |
priceSourceName | String (255) | Readable text on the origin of the price information, e.g. ‘Individual price list’ | |
priceStatus | Yes | String (255) | Textual information on price retrieval, e.g. ‘The retrieval of the data was successful’ |
priceBillingPeriod | Integer | Length of the price billing period | |
priceBillingPeriodUnit | String (40) | Unit of the price billing period (e.g. “Years”, “Month”) | |
priceSubscriptionPeriod | Integer | Length of the price subscription period | |
priceSubscriptionPeriodUnit | String (40) | Unit of the price subscription period (e.g. “Years”, “Month”) |
supplierStockInfo
Availability information for the source of supply.
Name | Compulsory field | Data type | Description |
---|---|---|---|
stockSupplierText | String (40) | Textual stock information from the supplier, this is directly taken over without interpretation | |
stockStatus | Yes | Integer | Numeric key of the delivery status of the stock information |
stockStatusText | Yes | String (255) | Delivery status for this stock information, such as ‘in stock’ or ‘in field warehouse’ |
stock | Yes | Integer | Quantity available for the delivery status indicated in this structure |
externalStock | Integer | External stock (additional information provided by some suppliers in structures with ‘in stock’ delivery status) | |
incomingStock | Integer | Stock quantity that will be replenished (additional information provided by some suppliers in structures with ‘in stock’ delivery status) | |
stockAvailabilityDate | Date | Delivery date for products that are not in stock | |
stockLastUpdate | Yes | Date | Time of last update of inventory information |
stockSourceId | Yes | Integer | Numeric key of the source of stock information |
stockSourceName | Yes | String (255) | Source of stock information, e.g. ‘Individual price list’ |
stockUnlimited | Yes | Boolean | Indicates whether the items of this stock information are available in an unlimited quantity |
project
Price, availability and further information on a project agreement.
Name | Compulsory field | Data type | Description |
---|---|---|---|
supplierProjectId | String (40) | Project number of the supplier | |
manufacturerProjectId | Yes | String (40) | Project number of the manufacturer (unique key) |
price | Yes | BigDecimal | Project price |
remainingQuantity | Yes | Integer | Remaining quota that can be ordered |
projectLastUpdate | Date | Time of last update of project information | |
projectBundleId | String (50) | Unique key of the project bundle | |
projectPosition | Integer | Project line item number |