JSON Implementation guide
Introduction
Welcome to the JSON Implementation Guide. Below you will find general guidelines for default JSON format DDS provides out of the box. If your company has chosen a custom format, this guide may still be of use in understanding the underlying data.
JSON
# Example of one JSON object per row
{"product_id".....}
{"product_id".....}
{"product_id".....}
{"product_id".....}
{"product_id".....}
# this is the non-flattend json for primary images
"primary_image": {
"name": "Scotch-Brite_Light_Duty_Cleansing_Pad_98.png",
"display_name": "primary_image",
"mime_type": "image/png",
"weight": 10,
"uri":"https://media.distributordatasolutions.com/xlsx_3M_synd/2021q1/images/large/8ee6ad83816f3f3f79d30b109bf570283b4a4953-large.png",
"sizes":{
"thumb":{
"length":"4983",
"uri":"https://media.distributordatasolutions.com/xlsx_3M_synd/2021q1/images/thumbnails/8ee6ad83816f3f3f79d30b109bf570283b4a4953-thumb.png"
},
"small":{
"length":"31752",
"uri":"https://media.distributordatasolutions.com/xlsx_3M_synd/2021q1/images/small/8ee6ad83816f3f3f79d30b109bf570283b4a4953-small.png"
},
"medium":{
"length":"128403",
"uri":"https://media.distributordatasolutions.com/xlsx_3M_synd/2021q1/images/medium/8ee6ad83816f3f3f79d30b109bf570283b4a4953-medium.png"
},
"large":{
"length":"545958",
"uri":"https://media.distributordatasolutions.com/xlsx_3M_synd/2021q1/images/large/8ee6ad83816f3f3f79d30b109bf570283b4a4953-large.png"
},
"native":{
"length":"3367671",
"uri":"https://media.distributordatasolutions.com/xlsx_3M_synd/2021q1/images/native/8ee6ad83816f3f3f79d30b109bf570283b4a4953-native.png"
}
}
}
Multi Part files
Our default JSON data is in multiple part files. There will be many files in the delivered directory. Filenames will follow the format part-{UUID with dashes}.json.
Multiple JSON Object per file
The most important thing to understand about the JSON format is that we provide one JSON object on each line of the files. Each JSON object represents a single product as described here: http://jsonlines.org/.
JSON NULL values
Null values are excluded in our JSON files fields. Any code you use to parse the json will need to handle the absence of a field you expect to be present. For example, not all manufacturers supply packaging dimensions.
Item Details
Item Details
{
"product_id": 913512,
"manufacturer_catalog_number": "141A-BS10",
"upc": "611320791747",
"name": "141A-BS10 - 141A MCS Mounting System Busbar Covers and Shrouds",
"short_description": "MCS Single Pole Snap-On Bus Bar Cover",
"long_description": "Individual Busbar Covers (for 10 mm Busbar), Priced per piece; must buy in multiples of 10",
"alternate_images": [],
"region_id": "GBR",
"country_of_origin": "DE",
"currency": "GBP",
"discount_code": "B7",
"family_code": "B141ABCVR",
"list_price": 13,
"manufacturer": {},
"order_min": 10,
"packages": [{}],
"preferred_product": "X",
"price_effective_date": "2017-08-27",
"primary_image": {},
"rohs_indicator": "COMPLIANT",
"prop_65_message":"No",
"tariff_code": "85472000",
"height": "7.010",
"height_uom": "CM",
"length": "11.000",
"length_uom": "CM",
"width": "10.210",
"width_uom": "CM",
"primary_spec_sheet": { },
"manufacturer_categories": [],
"facets": [],
"features": [],
"specifications": [],
"downloads": [],
"videos": []
}
| Field Name | Data Type | Description |
|---|---|---|
| distributor_product_id | String | Distributor unique identifier |
| product_id | Integer | DDS unique identifier |
| manufacturer_catalog_number | String | Uniquely Identifies the product within a manufacturer |
| upc | String | UPC (technically refers to UPC-A) consists of 12 numeric digits, that are uniquely assigned to each product. Can have leading Zeros |
| unspsc | Integer | The United Nations Standard Products and Services Code |
| name | String | Product name |
| short_description | String | Brief description of the product (will typically match the product name) |
| long_description | String | Longer description of the product |
| primary_image | List of Image Objects | Primary image |
| alternate_images | List of Image Objects | List of alternate images |
| region_id | String | Identifies which region the list price is associate with |
| country_of_origin | String | Country where the product was manufactured |
| currency | String | Currency of the list price |
| discount_code | String | Manufacturer's discount code |
| family_code | String | Identifies a product Group or Family. Defined by each individual manufacturer |
| list_price | Decimal | List price of the product for the specified region and currency |
| manufacturer | Manufacturer Object | Object detailing manfacturer, manufacturer logo and its parent, if applicable |
| order_min | Integer | Size of the minimum order as defined by the manufacturer |
| packages | List of Package Objects | List of different package size options |
| preferred_product | String | Manufacturer will identify a list products which are "preferred". An "X" signifies a preferred product |
| price_effective_date | DateTime | Data when a list price starts for a product |
| rohs_indicator | String | Restriction of Hazardous Substances Compliance |
| prop_65_message | String | Warning given for products sold in California |
| tariff_code | String | Tariff code |
| height | Double | Height of the product |
| height_uom | String | Abbreviation of the unit of measure for the height (standard or imperial based on the region id) |
| length | Double | Length of the product |
| length_uom | String | Abbreviation of the unit of measure for the length (standard or imperial based on the region id) |
| width | Double | Width of the product |
| width_uom | String | Abbreviation of the unit of measure for the length (standard or imperial based on the region id) |
| primary_spec_sheet | File Object | Primary spec sheet details. This file is also contained in the 'downloads' section. It is split out here as well for easy reference. |
| safety_data_sheet | File Object | Safety data sheet details. This file is also contained in the 'downloads' section. It is split out here as well for easy reference. |
| manufacturer_categories | List of Category Objects | Categorizations as outlined and provided by the manufacturer |
| facets | List of Facet Objects | A normalized subset of the specifications object where the specification names and values have been normalized across manufacturers |
| features | List of Attribute Objects | Marketing Information/Features in an attribute group. The attributes will not have a name |
| specifications | List of Attribute Objects | Product specifications in attribute groups. The attributes will have a name |
| downloads | List of File Objects | Downloads in file groups |
| videos | List of File Objects | Videos in file groups |
| etim | ETIM Object | International classification standard for technical products |
| certifications | List of Certification Objects | Certifications as provided by supplier |
| manufacturer_categories | List of MFR Category Objects | Categories as outlined by the manufacturer (where available) |
| images_360 | List of 360 Image Objects | 360 degree image delivered in an iframe url |
Images and Sizes
Images and Sizes
{
"name": "Scotch-Brite_Light_Duty_Cleansing_Pad_98.png",
"display_name": "primary_image",
"mime_type": "image/png",
"weight": 10,
"uri":"https://media.distributordatasolutions.com/xlsx_3M_synd/2021q1/images/large/8ee6ad83816f3f3f79d30b109bf570283b4a4953-large.png",
"sizes":{
"thumb":{
"length":"4983",
"uri":"https://media.distributordatasolutions.com/xlsx_3M_synd/2021q1/images/thumbnails/8ee6ad83816f3f3f79d30b109bf570283b4a4953-thumb.png"
},
"small":{
"length":"31752",
"uri":"https://media.distributordatasolutions.com/xlsx_3M_synd/2021q1/images/small/8ee6ad83816f3f3f79d30b109bf570283b4a4953-small.png"
},
"medium":{
"length":"128403",
"uri":"https://media.distributordatasolutions.com/xlsx_3M_synd/2021q1/images/medium/8ee6ad83816f3f3f79d30b109bf570283b4a4953-medium.png"
},
"large":{
"length":"545958",
"uri":"https://media.distributordatasolutions.com/xlsx_3M_synd/2021q1/images/large/8ee6ad83816f3f3f79d30b109bf570283b4a4953-large.png"
},
"native":{
"length":"3367671",
"uri":"https://media.distributordatasolutions.com/xlsx_3M_synd/2021q1/images/native/8ee6ad83816f3f3f79d30b109bf570283b4a4953-native.png"
}
}
}
We supply multiple sizes of the same image. This allows you to choose the size appropriate for your needs. All of our images are hosted on our Content Delivery Network(CDN) powered by Amazon CloudFront. There is no need to download and host the files yourself. Every file will be served from and secure HTTPS domain with a valid certificate.
Image Object
| Field Name | Data Type | Description |
|---|---|---|
| name | String | Often used for the filename attribute in the Content Disposition header |
| display_name | String | Usually shown as the text in the download link |
| mime_type | String | See Mozilla's documentation on Mime types here |
| weight | Integer | Used for sorting |
| uri | Sting | URI of the image on our CDN (https://media.distributordatasolutions.com/...) |
| sizes | Sizes Object | Object containing the parameters thumb, small, medium, large, and native |
Sizes Object
| Field Name | Data Type | Description |
|---|---|---|
| thumb | Size Object | Thumb Size Object. 64px x 62px Cropped*. Best for displaying in search results. |
| small | Size Object | Small Size Object. 256px x 256px Max*. Also good for displaying in search results or as the main image in your Product Details page. |
| medium | Size Object | Medium Size Object. 512px x 512px Max*. Good as the main Image in your Product Details Page. |
| large | Size Object | Large Size Object. 1024px x 1024px Max*. Good for a zoomed in version of the main image on the your Product Details page. |
| native | Size Object | Native Size Object. Original from manufacturer - Size varies. Good for a zoomed in version of the main image on your Product Details page. |
- "Max" will preserve the original aspect ratio of the image while "Cropped" will force the aspect ratio to a square image by cropping the longer sides
Size Object
| Field Name | Data Type | Description |
|---|---|---|
| uri | String | Fully qualified url of the image on our CDN. |
| size | Number | Size of the file in bytes. Not always present. Used to populate Content-length. |
Spec Sheet and SDS (Simple File Object)
Spec Sheet and Safety Data Sheet (SDS)
{
"name": "SB_Scouring Pads_HACCP INTL_Rev B.pdf",
"display_name": "Spec Sheet",
"mime_type": "application/pdf",
"uri": "https://media.distributordatasolutions.com/xlsx_3M_synd/2021q1/documents/608f424ece035b3af473d03030b0412d7185c9fb.pdf",
}
Both the Spec Sheet and Safety data Sheet(SDS) have the same format.
| Field Name | Data Type | Description |
|---|---|---|
| name | String | Name of the file |
| display_name | String | Spec Sheet or Safety Data Sheet |
| mime_type | String | typically "application/pdf". See Mime Types |
| uri | String | URL of the file on our CDN |
360 Images
360 Images
"images_360": [
{
"cols":"24",
"initial_image":"https://media.distributordatasolutions.com/xlsx_3M_synd/2021q1/360_images/medium/483ef5ff38ca15b34cd7debe629412e4583b5860-r01-c01-medium.png",
"rows":"1",
"filename":"483ef5ff38ca15b34cd7debe629412e4583b5860-r{row}-c{col}-medium.png",
"initial_thumb":"https://media.distributordatasolutions.com/xlsx_3M_synd/2021q1/360_images/thumbnails/483ef5ff38ca15b34cd7debe629412e4583b5860-r01-c01-thumb.png",
"filename_large":"483ef5ff38ca15b34cd7debe629412e4583b5860-r{row}-c{col}-native.png",
"format":"row-column",
"iframe_url":"https://media.distributordatasolutions.com/assets/magic360/viewer.html?initial=/xlsx_3M_synd/2021q1/360_images/medium/483ef5ff38ca15b34cd7debe629412e4583b5860-r01-c01-medium.png&filename=483ef5ff38ca15b34cd7debe629412e4583b5860-r{row}-c{col}-medium.png&rows=1&cols=24",
"display_name":"5b953d11faff491882675e9914aea6bf 360 Image"
}
],
Example
iframeusage
<iframe src="https://media.distributordatasolutions.com/assets/magic360/viewer.html?initial=/xlsx_3M_synd/2021q1/360_images/medium/483ef5ff38ca15b34cd7debe629412e4583b5860-r01-c01-medium.png&filename=483ef5ff38ca15b34cd7debe629412e4583b5860-r{row}-c{col}-medium.png&rows=1&cols=24"></iframe>
A product may have 360 degree images available. If so, they will be present as an array in the images_360 key. DDS has provided a simple integration where you can embed a 360 viewer in an iframe. You only need to set the iframe_url value as the src for the iframe.
Packages
Packages
# NOTICE. Many of the packaging fields are null and therfore excluded
"packages": [
{
"code": "14a2edeb9f734eb395d7d0ddc87c491d",
"gtin": "50042269002420",
"qty": 25,
"qty_uom": "CASE",
"gross_weight": 10.5,
"gross_weight_uom": "L",
"pkg_length": 10,
"pkg_length_uom": "IN",
"pkg_height": 6.3,
"pkg_height_uom": "IN",
"pkg_width": 6.7,
"pkg_width_uom": "IN",
"description": "Case",
"returnable": "Y"
}
]
Package Object
| Field Name | Data Type | Description |
|---|---|---|
| code | String | Unique DDS hash for the package |
| gtin | String | Usually GTIN-14, however could be any GTIN. see www.gtin.info. |
| sub_gtin | String | If the package contains smaller packaging. This is the GTIN of those packages. |
| sub_qty | String | Number of "sub" packages |
| qty | String | Quantity |
| qty_uom | String | Quantity Unit of Measure |
| gross_weight | Number | Weight |
| gross_weight_uom | String | Weight Unit of Measure |
| pkg_length | Number | Length |
| pkg_length_uom | String | Length Unit of Measure |
| pkg_height | Number | Height |
| pkg_height_uom | String | Height Unit of Measure |
| pkg_width | Number | Width |
| pkg_width_uom | String | Width Unit of Measure |
| description | String | An explanation of the packaging |
| returnable | String | Indicates if the product is returnable or not |
Manufacturer
Manufacturer
"manufacturer": {
"parent_id":32,
"parent_name":"Legrand",
"name":"Pass & Seymour",
"id":33,
"image": {
"name":"primary_image",
"mime_type":"image/png",
"weight":30,
"uri":"https://media.distributordatasolutions.com/ManufacturerLogos/Pass+%26+Seymour/_sized/primary_logo-large.png",
"sizes": {
"thumb": {
"uri":"https://media.distributordatasolutions.com/ManufacturerLogos/Pass+%26+Seymour/_sized/primary_logo-thumb.png"
},
"small": {
"uri":"https://media.distributordatasolutions.com/ManufacturerLogos/Pass+%26+Seymour/_sized/primary_logo-small.png"
},
"medium": {
"uri":"https://media.distributordatasolutions.com/ManufacturerLogos/Pass+%26+Seymour/_sized/primary_logo-medium.png"
},
"large": {
"uri":"https://media.distributordatasolutions.com/ManufacturerLogos/Pass+%26+Seymour/_sized/primary_logo-large.png"
}
}
}
}
Object containing information about the manufacturer and its parent where applicable. (JSON only)
Manufacturer/Distributor Categories
Manufacturer/Distributor Categories
"manufacturer_categories": [
{
"name": "ENERGY MANAGEMENT",
"code": "49ae78b359f47eec973f84da57f48490"
},
{
"name": "C I OCCUPANCY SENSORS",
"parent_code": "49ae78b359f47eec973f84da57f48490",
"code": "5dd16e922ba02ed5a7f5f72bd253ecd6"
}
]
"distributor_categories":[
{
"category_id":690156,
"code":"690156",
"name":"Tools & Hardware"
},
{
"category_id":690237,
"code":"690237",
"name":"Power Tools & Accessories",
"parent_id":690156
},
{
"category_id":690278,
"code":"690278",
"name":"Power Saws & Accessories",
"parent_id":690237
}
]
Manufacturer Categories provided directly from the manufacturer, or distributor specific categories and taxonomy.
Category Object
| Field Name | Data Type | Description |
|---|---|---|
| category_id | Integer | Unique ID for each category |
| parent_id | Integer | References the parent category_id |
| code | String | UUID that uniquely identifies each category |
| parent_code | String | UUID that references back to the parent category |
| name | String | Category name |
Facets
Facets
"facets": [
{
"data_key": "overall_length",
"name": "Overall Length",
"values": [
{
"value": "25.4",
"value_with_uom": "25.4 millimeters",
"uom_unit": "millimeter",
"uom_unit_plural": "millimeters",
"uom_abbreviation": "mm",
"uom_abbreviation_plural": "mm"
}
]
},
{
"data_key": "material",
"name": "Material",
"values": [
{
"value": "ABS",
"value_with_uom": "ABS"
},
{
"value": "Plastic",
"value_with_uom": "Plastic"
}
]
}
],
Facets are normalized and filterable attributes processed by our data team. They are extracted from product details and the unit of measure is separated, if applicable.
Facet Object
| Field Name | Data Type | Description |
|---|---|---|
| data_key | String | Uniquely identifies the facet |
| name | String | Display name |
| values | List of Facet value Objects | List of facet values |
Facet Value Object
| Field Name | Data Type | Description |
|---|---|---|
| value | String | value without the unit of measure |
| value_with_uom | String | Value with the unit of measure added, considers pluralization |
| uom_unit | String | Singular text of the unit of measure |
| uom_unit_plural | Plural version of the unit of measure | |
| uom_abbreviation | Singular abbreviation of the unit of measure | |
| uom_abbreviation_plural | Plural version of abbreviation of the unit of measure |
Features and Specifications
Features and Specifications
"specifications": [
{
"group_name": "Busbar Cover Data",
"group_items": [
{
"name": "Busbar Cover and Shroud",
"value": "Individual Busbar Covers (for 10 mm Busbar)"
}
]
}
],
"features": [
{
"group_items":[
{
"value":"Internal flanges provide solid, twist-resistant shaft anchor",
"weight":50
},
{
"value":"Cushion-Grip handle allows for greater torque and comfort",
"weight":30
},
{
"value":"Hollow shank facilitates work on bolt applications",
"weight":20
},
{
"value":"Exclusive hollow shaft design with Rare Earth magnetic tip features unobstructed pass-through, even on long bolts",
"weight":10
},
{
"value":"Handle end is color coded for easy identification",
"weight":40
}
]
},
{
"group_name":"Warnings",
"group_items":[
{
"value":"NOT insulated. Will NOT protect against electrical shock.",
"weight":20
},
{
"value":"Always wear approved eye protection.",
"weight":10
}
]
}
]
Features and Specifications are delivered in grouped attributes. It is typical for manufactures to group their data in sub sections to add another level of context. Each group has a name and a list of attributes.
Features
Feature are typically displayed on manufactures site's as a bulleted list
Specifications
Specifications are typically displayed on a manufacture site in name value pairs, with the name bold and followed by a colon. Another method is to put the name value pairs in a table but is less common.
Group Object (Attributes)
| Field Name | Data Type | Description |
|---|---|---|
| group_name | String | Display name of the group |
| group_items | List of Attribute Objects | List of Attribute Objects that have name value pair |
Attribute Object
| Field Name | Data Type | Description |
|---|---|---|
| name | String | Display name for the attributes |
| value | String | Value |
Downloads and Videos
Downloads and Videos
"downloads": [
{
"group_name": "Manuals",
"group_items": [
{
"name": "22d-qs001_-en-p.pdf",
"display_name": "Quick Start Manual",
"mime_type": "application/pdf",
"uri": "https://media.distributordatasolutions.com/AB-Symmetrix/2018q2/495d211239c5cc2cad89c4b2a4a1562ee0de50b4.pdf",
"ext_hosted": 0,
"weight": 10,
"description": "(videos only)",
"duration": "(videos only)",
"embed_html": "(videos only)"
},
]
},
Downloads and Videos are delivered in grouped files. It is typical for manufactures to group their data in sub sections to add another level of context. Each group has a name and a list of files.
Group Object (Files)
| Field Name | Data Type | Description |
|---|---|---|
| group_name | String | Display name of the group |
| group_items | List of File Objects | List of File Objects |
File Object
| Field Name | Data Type | Description |
|---|---|---|
| name | String | The name of the file |
| display_name | String | The display name for the file. Typically it is more human readable than the name. |
| mime_type | String | MimeType of the File |
| uri | String | Uri of the file or video. If ext_hosted is not 1, it will be hosted on our CDN. |
| ext_hosted | String | (Videos Only) 1 or null. If 1 use the "embedded_html" to display the video. |
| weight | Int | Used for sorting |
| description | String | a long description |
| duration | String | (Videos only) How long a Video is |
| embed_html | String | (Videos only) required when a video is hosted by an external provider (YouTube, Vimeo, etc...). |
Multi CSV Implementation guide
Introduction
Welcome to the Multi CSV Implementation Guide. Below you will find general guidelines for default CSV format DDS provides out of the box. If your company has chosen a custom format, this guide may still be of use in understanding the underlying data.
Multi CSV
Multiple CSVs
The Default Multi CSV format will provide each of the following files:
- items.csv
- alternate-images.csv
- features.csv
- specifications.csv
- downloads.csv
- videos.csv
- facets.csv
- facets-keys.csv
- image360.csv
- manufacturer-categories.csv
Multiple files are necessary to more easily deliver the data that has multiple values for a single data type. For example, many products will have multiple downloadable files. These are contained in the downloads.csv.
All files contain a product_id column. In the items.csv file there is only one row per product_id. In all the other files there is the possibility of multiple rows per product_id. This allows for a one to many relationship. For instance, each product (one) has multiple downloads (many).
Separating the data into multiple files eliminates the need for numbered columns like document1,document2... and allows us to avoid a maximum number of items restriction and a large number of empty columns when a product does not have the maximum number. We can also include more relevant data for each item. For example, we provide a mime type, display name and a possible description for downloads.
CSV Standards
Our csv documents follow the RFC 4180 standard. A brief explanation is also available on the CSV wikipedia page (Scroll down to the RFC 4180 standard section).
Depending on the technology you use for you implementation you should set your csv settings to the following:
Configuration
| Key | Value | Description |
|---|---|---|
| Header | true | All our CSVs have headers |
| Delimiter | , | Comma |
| Text Qualifier | " | Double quote. Columns are only wrapped with double quotes when the column text would break the parsing. This usually means the text contains a comma, double quote or a new line character. |
| Escape Character | " | Double Quote. Any double quote found in the text of a column will be preceded by another double quote. If the text has a double quote as the first character you will see 3 double quotes in a row. One for the start of the text, one as the escape character and the 3rd as the actually double character. |
Item Details
Item Details
# items.csv
product_id,manufacturer_catalog_number,name,upc,manufacturer_name,product_title,long_description,short_description,invoice_description,rohs_indicator,family_code,preferred_product,length,length_uom,width,width_uom,height,height_uom,weight,weight_uom,sub_brand,custom_keywords,prop_65_message,ean,upc_11,retail_flag,country_of_origin,abc_classification,hazardous_material,manufacturer_product_group,region_id,list_price,units_qty,units_uom,price_country_of_origin,order_min,order_min_uom,order_increment,price_effective_date,price_expiration_date,currency,tariff_code,stocked,discount_code,price_group_code,sub_discount_code,standard_lead_time,export_commerce_control_number,business_group,product_life_cycle_status,language_code,tech_segment,next_effective_date,next_list_price,trade_price,user_price,dist_price,primary_thumb_uri,primary_image_name,primary_image_display_name,primary_image_mime_type,primary_image_thumb_uri,primary_image_small_uri,primary_image_medium_uri,primary_image_large_uri,primary_image_native_uri,primary_spec_sheet_uri,primary_spec_sheet_name,primary_spec_sheet_display_name,primary_spec_sheet_mime_type,safety_data_sheet_uri,safety_data_sheet_name,safety_data_sheet_display_name,safety_data_sheet_mime_type
| Field Name | Data Type | Description |
|---|---|---|
| product_id | String | Unique Identifier |
| name | String | Product name |
| upc | String | UPC (technically refers to UPC-A) consists of 12 numeric digits, that are uniquely assigned to each product. Can have leading Zeros |
| manufacturer_name | String | Manufacturer of the product |
| product_title | Sting | Title of product if outlined by Manufacturer |
| short_description | Sting | Brief description of the product (will typically match the product name) |
| long_description | String | Longer description of the product |
| invoice_description | String | Description outlined by Manufacturer for invoicing |
| rohs_indicator | String | Restriction of Hazardous Substances Compliance |
| family_code | String | Identifies a product Group or Family. Defined by each individual manufacturer |
| preferred_product | String | Manufacturer will identify a list products which are "preferred". An "X" signifies a preferred product |
| length | Double | Length of the product |
| length_uom | String | Abbreviation of the unit of measure for the length (standard or imperial based on the region id) |
| width | Double | Width of the product |
| width_uom | String | Abbreviation of the unit of measure for the length (standard or imperial based on the region id) |
| height | Double | Height of the product |
| height_uom | String | Abbreviation of the unit of measure for the height (standard or imperial based on the region id) |
| weight | Double | Weight of the product |
| weight_uom | String | Abbreviation of the unit of measure for the height (standard or imperial based on the region id) |
| sub_brand | String | Sub Brand of Manufacturer |
| custom_keywords | String | Keywords typically used for SEO where outlined by Manufacturer |
| prop_65_message | String | Warning given for products sold in California |
| ean | String | European Article Number |
| upc_11 | String | 11 Digit UPC |
| retail_flag | String | |
| country_of_origin | String | Country where the product was manufactured |
| abc_classification | String | |
| hazardous_material | String | Flag where product is distinguished as a hazardous material |
| manufacturer_product_group | String | |
| region_id | String | Identifies which region the list price is associate with |
| list_price | Decimal | List price of the product for the specified region and currency |
| units_qty | String | |
| units_uom | String | |
| price_country_of_origin | Decimal | |
| order_min | Integer | Size of the minimum order as defined by the manufacturer |
| order_min_uom | String | |
| order_increment | String | |
| price_effective_date | String | Data when a list price starts for a product |
| price_expiration_date | String | Data when a list price ends for a product |
| currency | String | Currency of the list price |
| tariff_code | String | Tariff code |
| stocked | String | Stock status |
| discount_code | String | Manufacturer's discount code |
| price_group_code | String | |
| sub_discount_code | String | |
| standard_lead_time | String | |
| export_commerce_control_number | String | |
| business_group | String | |
| product_life_cycle_status | String | |
| language_code | String | |
| tech_segment | String | |
| next_effective_date | String | |
| next_list_price | Decimal | |
| trade_price | Decimal | |
| user_price | Decimal | |
| dist_price | Decimal | |
| primary_thumb_uri | String | |
| primary_image_name | String | Image file name |
| primary_image_display_name | String | Image display name |
| primary_image_mime_type | String | See Mozilla's documentation on Mime types here |
| primary_image_thumb_uri | String | Thumbnail sized image |
| primary_image_small_uri | String | Small sized image |
| primary_image_medium_uri | String | Medium sized image |
| primary_image_large_uri | String | Large sized image |
| primary_image_native_uri | String | Native sized image |
| primary_spec_sheet_uri | String | Primary spec sheet URI. This file is also contained in the 'downloads' section. It is split out here as well for easy reference. |
| primary_spec_sheet_name | String | Primary spec sheet file name |
| primary_spec_sheet_display_name | String | Display Name |
| primary_spec_sheet_mime_type | String | See Mozilla's documentation on Mime types here |
| safety_data_sheet_uri | String | |
| safety_data_sheet_name | String | |
| safety_data_sheet_display_name | String | |
| safety_data_sheet_mime_type | String | See Mozilla's documentation on Mime types here |
Images and Sizes
Images and Sizes
# alternate-images.csv
product_id, name, display_name, uri, mime_type, small_uri, medium_uri, large_uri, native_uri,
We supply multiple sizes of the same image. This allows you to choose the size appropriate for your needs. All of our images are hosted on our Content Delivery Network(CDN) powered by Amazon CloudFront. There is no need to download and host the files yourself. Every file will be served from and secure HTTPS domain with a valid certificate.
Image Object
| Field Name | Data Type | Description |
|---|---|---|
| product_id | String | Unique Identifier |
| name | String | Often used for the filename attribute in the Content Disposition header |
| display_name | String | Usually shown as the text in the download link |
| mime_type | String | See Mozilla's documentation on Mime types here |
| small/medium/large/native uri | String | URI of the image on our CDN (https://media.distributordatasolutions.com/...) |
Image Sizes
| Field Name | Description |
|---|---|
| thumb | Thumb Size Object. 64px x 62px Cropped*. Best for displaying in search results. |
| small | Small Size Object. 256px x 256px Max*. Also good for displaying in search results or as the main image in your Product Details page. |
| medium | Medium Size Object. 512px x 512px Max*. Good as the main Image in your Product Details Page. |
| large | Large Size Object. 1024px x 1024px Max*. Good for a zoomed in version of the main image on the your Product Details page. |
| native | Native Size Object. Original from manufacturer - Size varies. Good for a zoomed in version of the main image on your Product Details page. |
- "Max" will preserve the original aspect ratio of the image while "Cropped" will force the aspect ratio to a square image by cropping the longer sides
360 Images
# image360.csv
product_id,cols,rows,initial_image,filename,initial_thumb,filename_large,format,iframe_url,display_name
22017267,24,1,https://media.distributordatasolutions.com/xlsx_rubix_cube/2021q4/360_images/medium/ad88b0727c35474db7fd46e5d397d169ece27645-r01-c01-medium.png,ad88b0727c35474db7fd46e5d397d169ece27645-r{row}-c{col}-medium.png,https://media.distributordatasolutions.com/xlsx_rubix_cube/2021q4/360_images/thumbnails/ad88b0727c35474db7fd46e5d397d169ece27645-r01-c01-thumb.png,ad88b0727c35474db7fd46e5d397d169ece27645-r{row}-c{col}-native.png,row-column,https://media.distributordatasolutions.com/assets/magic360/viewer.html?initial=/xlsx_rubix_cube/2021q4/360_images/medium/ad88b0727c35474db7fd46e5d397d169ece27645-r01-c01-medium.png&filename=ad88b0727c35474db7fd46e5d397d169ece27645-r{row}-c{col}-medium.png&rows=1&cols=24,b14a9b7fb6df40c9bc0758ad00cee754 360 Image
# Example `iframe` usage
html
<iframe src="https://media.distributordatasolutions.com/assets/magic360/viewer.html?initial=/xlsx_3M_synd/2021q1/360_images/medium/483ef5ff38ca15b34cd7debe629412e4583b5860-r01-c01-medium.png&filename=483ef5ff38ca15b34cd7debe629412e4583b5860-r{row}-c{col}-medium.png&rows=1&cols=24"></iframe>
A product may have 360 degree images available. If so, they will be present in the image_360.csv file. DDS has provided a simple integration where you can embed a 360 viewer in an iframe. You only need to set the iframe_url value as the src for the iframe.
Manufacturer Categories
Categories
# manufacturer-categories.csv
product_id,category_id,parent_id,code,name
22017267,1293942,1293941,049e3087778fb9a172b31b19dd442a0e,Cubes
22017267,1293941,"",75a590f43c0627b38b8c3e6f7c557313,Objects
22017267,1293943,1293942,d0e32a31200e8055acf38eacf420a022,Rubix Cubes
Manufacturer categories (also known as taxonomy) is a 3 level deep classification where available from the manufacturer.
Category Object
| Field Name | Data Type | Description |
|---|---|---|
| category_id | Integer | Unique ID for each category |
| parent_id | Integer | References the parent category_id |
| code | String | UUID that uniquely identifies each category |
| name | String | Category name |
Facets
Facets
#facets.csv
product_id,data_key,name,value,value_with_uom,uom_unit,uom_unit_plural,uom_abbreviation,uom_abbreviation_plural
99999,overall_length,Overall Length,25.4,25.4 millimeters,millimeter,millimeters,mm,mm
88888,material,Material,ABS,ABS,,,,,
88888,material,Material,Plastic,Plastic,,,,,
#facet-keys.csv
data_key,name
overal_length,Overall Length
material,Material
Facets are normalized and filterable attributes processed by our data team. They are extracted from product details and the unit of measure is separated, if applicable.
Multi-CSV
Facets in the Multi-CSV delivery are de-normalized. We provide two files: facets.csv and facet-keys.csv. A facet can have multiple values. For example, a product can have more than one color. Consider a black and yellow DEWALT drill. facets.csv has a row for every facet value and therefore can have multiple per product id and facet key.
facet-keys.csv is list of distinct facet_keys and names. Some client like to pre-process the facet keys to identify internal ids and then process the facet values.
Facet Object
| Field Name | Data Type | Description |
|---|---|---|
| data_key | String | Uniquely identifies the facet |
| name | String | Display name |
| values | List of Facet value Objects | List of facet values |
Facet Value Object
| Field Name | Data Type | Description |
|---|---|---|
| value | String | value without the unit of measure |
| value_with_uom | String | Value with the unit of measure added, considers pluralization |
| uom_unit | String | Singular text of the unit of measure |
| uom_unit_plural | Plural version of the unit of measure | |
| uom_abbreviation | Singular abbreviation of the unit of measure | |
| uom_abbreviation_plural | Plural version of abbreviation of the unit of measure |
Features and Specifications
Features and Specifications
# features.csv/specifications.csv
product_id,group_name,name,value,weight
22017267,Applications,"",Universal applications,0
22017267,"","",Endless entertainment,10
22017267,"","",Multi-colored,0
22017267,"","",A 10 cent piece of plastic,20
22017267,Includes,"",Nothing else,10
22017267,Includes,"",A single cube,0
Features and Specifications are delivered in grouped attributes. It is typical for manufactures to group their data in sub sections to add another level of context. Each group has a name and a list of attributes.
Features
Features are typically displayed on manufacturer's sites as a bulleted list
Specifications
Specifications are typically displayed on a manufacturer site in name value pairs, with the name bold and followed by a colon. Another method is to put the name value pairs in a table but is less common.
Group Object (Attributes)
| Field Name | Data Type | Description |
|---|---|---|
| group_name | String | Display name of the group |
| group_items | List of Attribute Objects | List of Attribute Objects that have name value pair |
Attribute Object
| Field Name | Data Type | Description |
|---|---|---|
| name | String | Display name for the attributes |
| value | String | Value |
Downloads and Videos
Downloads and Videos
# downloads.csv/videos.csv
product_id,group_name,name,display_name,mime_type,uri,ext_hosted,weight,description,duration,embed_html
22017267,Solution,Rubix_cube_solution.pdf,Solution Manual,application/pdf,https://media.distributordatasolutions.com/xlsx_rubix_cube/2021q4/documents/c339bd52ca5daa5162b8cecc897056520acf0539.pdf,0,0,"","",""
22017267,"",RBL_solve_guide_CUBE_US_5.375x8.375in_AW_27Feb2020_VISUAL.pdf,Catalog,application/pdf,https://media.distributordatasolutions.com/xlsx_rubix_cube/2021q4/documents/6e33c73e2588c97dfacc466ce20ab101eac2a190.pdf,0,30,"","",""
Downloads and Videos are delivered in grouped files. It is typical for manufactures to group their data in sub sections to add another level of context. Each group has a name and a list of files.
Group Object (Files)
| Field Name | Data Type | Description |
|---|---|---|
| group_name | String | Display name of the group |
| group_items | List of File Objects | List of File Objects |
File Object
| Field Name | Data Type | Description |
|---|---|---|
| name | String | The name of the file |
| display_name | String | The display name for the file. Typically it is more human readable than the name. |
| mime_type | String | MimeType of the File |
| uri | String | Uri of the file or video. If ext_hosted is not 1, it will be hosted on our CDN. |
| ext_hosted | String | (Videos Only) 1 or null. If 1 use the "embedded_html" to display the video. |
| weight | Int | Used for sorting |
| description | String | a long description |
| duration | String | (Videos only) How long a Video is |
| embed_html | String | (Videos only) required when a video is hosted by an external provider (YouTube, Vimeo, etc...). |
XML Implementation guide
Introduction
Welcome to the XML Implementation Guide. Below you will find general guidelines for default XML format DDS provides out of the box. If your company has chosen a custom format, this guide may still be of use in understanding the underlying data.
Multi Part files
Our default XML data is in multiple part files. There will be many files in the delivered directory.
Filenames will follow the format part-{UUID with dashes}.xml.
The files only contain root level tag (
XML NULL values
Null values are excluded in our XML files fields. Any code you use to parse the XML will need to handle the absence of a field you expect to be present. For example, not all manufacturers supply packaging dimensions. Rather than providing an empty packaging tag, the tag is omitted.
# Example of one XML root and row objects per part file
<products>
<product>.....</product>
<product>.....</product>
<product>.....</product>
</products>
Product
Product
<product>
<manufacturer_name>Generic Manufacturer</manufacturer_name>
<code>a413f8e07a249a7be2cbefe510996fd3</code>
<manufacturer_catalog_number>NSYCVF85M230PF</manufacturer_catalog_number>
<name>Generic Product Name</name>
<upc>78590169865</upc>
<price>
<region_id>USA</region_id>
<list_price>999.99</list_price>
<country_of_origin>FR</country_of_origin>
<price_effective_date>2019-10-01</price_effective_date>
<stocked>Non-S</stocked>
<standard_lead_time>15</standard_lead_time>
</price>
<primary_image>
<name>DB300479_4000x4000.png</name>
<display_name>IMAGE</display_name>
<mime_type>image/png</mime_type>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/8f0721ce74a631bd2533af863d407dcd2e3de6d0-large.png</uri>
<sizes>
<thumb>
<length>3447</length>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/8f0721ce74a631bd2533af863d407dcd2e3de6d0-thumb.png</uri>
</thumb>
<small>
<length>6903</length>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/8f0721ce74a631bd2533af863d407dcd2e3de6d0-small.png</uri>
</small>
<medium>
<length>6903</length>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/8f0721ce74a631bd2533af863d407dcd2e3de6d0-medium.png</uri>
</medium>
<large>
<length>6903</length>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/8f0721ce74a631bd2533af863d407dcd2e3de6d0-large.png</uri>
</large>
<native>
<length>6903</length>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/8f0721ce74a631bd2533af863d407dcd2e3de6d0-native.png</uri>
</native>
</sizes>
</primary_image>
<alternate_images>
<alternate_image>
<name>DB300387_4000x4000.png</name>
<display_name>High Res PNG</display_name>
<mime_type>image/png</mime_type>
<weight>10</weight>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/e6f8051c914ae9c2ce0c9b4b22ef442500276aa0-large.png</uri>
<sizes>
<thumb>
<length>3626</length>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/e6f8051c914ae9c2ce0c9b4b22ef442500276aa0-thumb.png</uri>
</thumb>
<small>
<length>10627</length>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/e6f8051c914ae9c2ce0c9b4b22ef442500276aa0-small.png</uri>
</small>
<medium>
<length>10627</length>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/e6f8051c914ae9c2ce0c9b4b22ef442500276aa0-medium.png</uri>
</medium>
<large>
<length>10627</length>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/e6f8051c914ae9c2ce0c9b4b22ef442500276aa0-large.png</uri>
</large>
<native>
<length>10627</length>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/e6f8051c914ae9c2ce0c9b4b22ef442500276aa0-native.png</uri>
</native>
</sizes>
</alternate_image>
</alternate_images>
<primary_spec_sheet>
<name>ClimaSys_NSYCVF85M230PF.pdf</name>
<display_name>Product Datasheet (pdf)</display_name>
<mime_type>application/pdf</mime_type>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/722f89fc2e124968b7ebb3734d089b4f595ea7f7.pdf</uri>
<weight>10</weight>
</primary_spec_sheet>
<safety_data_sheet>
<name>msds.pdf</name>
<display_name>Manufacturer Safety Datasheet (pdf)</display_name>
<mime_type>application/pdf</mime_type>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/722f89fc2e124968b7ebb3734d089b4f595ea7f7.pdf</uri>
<weight>10</weight>
</safety_data_sheet>
<packages>
<package>
<gtin>00785901698654</gtin>
<gross_weight>0.84</gross_weight>
<gross_weight_uom>Lbs</gross_weight_uom>
</package>
</packages>
<facets>
<facet>
<data_key>color</data_key>
<name>Color</name>
<values>
<value>
<facet_value>Outlet Grille Grey RAL 7035)</facet_value>
<value_with_uom>Outlet Grille Grey RAL 7035)</value_with_uom>
</value>
</values>
</facet>
<facet>
<data_key>country_of_origin</data_key>
<name>Country of Origin</name>
<values>
<value>
<facet_value>France</facet_value>
<value_with_uom>France</value_with_uom>
</value>
</values>
</facet>
</facets>
<categories>
<category>
<category_id>445162</category_id>
<code>193c73ee12e172017850cbcb9025344e</code>
<name>Thermal Management</name>
<parent_id>443023</parent_id>
</category>
<category>
<category_id>443022</category_id>
<code>6289ca5fa1962a331a79fb511330eef0</code>
<name>Electrical Enclosures & Boxes</name>
</category>
<category>
<category_id>443023</category_id>
<code>b580b3d6dae788677ecddba162e2153c</code>
<name>Enclosure Accessories</name>
<parent_id>443022</parent_id>
</category>
</categories>
<image_360>
<cols>24</cols>
<rows>1</rows>
<initial_image>https://media.distributordatasolutions.com/XXXXXXX/2021q2/360_images/medium/000014d91bcfa43ad4eacb2c6a2b670c9ce836ec-r01-c01-medium.png</initial_image>
<filename>000014d91bcfa43ad4eacb2c6a2b670c9ce836ec-r01-c01-medium.png</filename>
<initial_thumb>https://media.distributordatasolutions.com/XXXXXXX/2021q2/360_images/thumb/000014d91bcfa43ad4eacb2c6a2b670c9ce836ec-r01-c01-thumb.png</initial_thumb>
<filename_large>000014d91bcfa43ad4eacb2c6a2b670c9ce836ec-r01-c01-large.png</filename_large>
<format>png</format>
<iframe_url>
<iframe src="https://media.distributordatasolutions.com/assets/magic360/viewer.html?initial=/xlsx_3M_synd/2021q1/360_images/medium/483ef5ff38ca15b34cd7debe629412e4583b5860-r01-c01-medium.png&filename=483ef5ff38ca15b34cd7debe629412e4583b5860-r{row}-c{col}-medium.png&rows=1&cols=24">
</iframe>
</iframe_url>
<display_name>000014d91bcfa43ad4eacb2c6a2b670c9ce836ec 360 image</display_name>
</image_360>
<features>
<group>
<group_name>Warnings</group_name>
<group_items>
<item>
<value>NOT insulated. Will NOT protect against electrical shock.</value>
<weight>20</weight>
</item>
<item>
<value>Always wear approved eye protection.</value>
<weight>10</weight>
</item>
</group_items>
</group>
</features>
<specifications>
<group>
<group_name>Complementary</group_name>
<group_items>
<item>
<name>Absorbed Power</name>
<value>15 W 60 Hz || 17 W 50 Hz</value>
<weight>80</weight>
</item>
</group_items>
</group>
<group>
<group_name>Contractual Warranty</group_name>
<group_items>
<item>
<name>Warranty</name>
<value>18 months</value>
<weight>360</weight>
</item>
</group_items>
</group>
<group>
<group_name>Main</group_name>
<group_items>
<item>
<name>Flow Rate</name>
<value>Free flow rate with standard filter 22455.03 Gal/hr(US) (85 m3/h) 50 Hz || Free flow rate with standard filter 25889.32 Gal/hr(US) (98 m3/h) 60 Hz</value>
<weight>50</weight>
</item>
</group_items>
</group>
<group>
<group_name>Offer Sustainability</group_name>
<group_items>
<item>
<name>California Proposition 65</name>
<value>WARNING: This product can expose you to chemicals including: Lead and lead compounds, which is known to the State of California to cause cancer and birth defects or other reproductive harm. For more information go to www.p65warnings.ca.gov</value>
<weight>320</weight>
</item>
</group_items>
</group>
<group>
<group_name>Ordering And Shipping Details</group_name>
<group_items>
<item>
<name>Category</name>
<value>80036 - ENCLOSURE SYSTEMS ACCESSORIES</value>
<weight>260</weight>
</item>
</group_items>
</group>
</specifications>
<downloads>
<group>
<group_items>
<item>
<name>SB200482_3D-simplified</name>
<display_name>Filterfan 85m3/h 230V IP54 (stp)</display_name>
<mime_type>application/step</mime_type>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/51a1970b8fda1ed93500ecac7fb7c578990de424</uri>
<ext_hosted>0</ext_hosted>
<weight>90</weight>
<locale>en-US</locale>
<manufacturer_file_id>SB200482_3D-simplified</manufacturer_file_id>
</item>
</group_items>
</group>
</downloads>
<videos>
<group>
<group_items>
<item>
<name>Locating Coil Consumption Details on RXG Interface Relays</name>
<mime_type>text/html</mime_type>
<uri>https://www.youtube.com/embed/W6W-90ovcos</uri>
<ext_hosted>1</ext_hosted>
<weight>20</weight>
<locale>en-US</locale>
<description>Tutorial for locating the Coil Consumption Details </description>
</item>
</group_items>
</group>
</videos>
<etim>
<group_code>EG00001</group_code>
<group_description>generic group</group_description>
<class_code>EC00001</class_code>
<class_description>generic class</class_description>
<version>7</version>
<features>
<feature_code>EF00001</feature_code>
<value_code>EV00001</value_code>
<value_string>generic value</value_string>
<feature_name>generic feature</feature_name>
</features>
</etim>
<product_title>XB5 Head with Key, 22 mm, Plastic Bezel, 3-Pos., Stay-Put</product_title>
<long_description>This head with key (key no.520E) provides a versatile interface for controlling your machines. It is easily installed and replaced on compatible complete key selector switch units. It provides a secure manner for authorized staff to switch between process or machine operating modes. It is impact resistant, dust resistant, water resistant and vibration resistant thanks to its IP66. It makes it ideal for operation in harsh environments.</long_description>
<short_description>ClimaSys forced vent. IP54, 85m3/h, 230V, with outlet grille and filter G2</short_description>
<invoice_description>ClimaSys forced vent. IP54, 85m3/h, 230V, with outlet grille and filter G2</invoice_description>
<rohs_indicator>X</rohs_indicator>
<family_code>123ABC</family_code>
<preferred_product>N</preferred_product>
<length>1.0</>
<length_uom>in</>
<width>1.0</>
<width_uom>in</>
<height>1.0</>
<height_uom>in</>
<weight>1.0</>
<weight_uom>in</>
<sub_brand>Sub Brand</sub_brand>
<custom_keywords>[Us] rated supply voltage:175...253 V|air flow:free flow rate with standard filter: 22455.03 Gal/hr(US) (85 m3/h) at 50 Hz,free flow rate with standard filter: 25889.32 Gal/hr(US) (98 m3/h) at 60 Hz|input voltage:230 V 50/60 Hz|product name:ClimaSys CV|product or component type:fan|range:ClimaSys|type of ventilation filter:standard</custom_keywords>
<prop_65_message>This product can expose you to chemicals including: Lead and lead compounds, which is known to the State of California to cause cancer and birth defects or other reproductive harm. For more information go to www.p65warnings.ca.gov</prop_65_message>
<ean>3606480151200</ean>
<upc_11>78590169865</upc_11>
<retail_flag>true</retail_flag>
<country_of_origin>FR</country_of_origin>
<abc_classification>500A</abc_classification>
<hazardous_material>false</hazardous_material>
<manufacturer_product_group>123ABC</manufacturer_product_group>
</product>
| Field Name | Data Type | Description |
|---|---|---|
| manufacturer_name | String | name of product manufacturer |
| code | String | UUID assigned by DDS to each product |
| manufacturer_catalog_number | String | Uniquely Identifies the product within a manufacturer |
| name | String | Product name |
| price | Price Object | See Price |
| primary_image | Image Object | see Images and Sizes |
| alternate_images | List of Image Objects | see Images and Sizes |
| primary_spec_sheet | File Object | see Spec Sheet and SDS (Simple File Object) |
| safety_data_sheet | File Object | see Spec Sheet and SDS (Simple File Object) |
| packages | List Package Objects | see Packages |
| facets | List of Facet Objects | see Facets |
| categories | List of Category Objects | see Categories |
| image_360 | Image 360 Object | see 360 Images |
| features | List of Attribute Objects | Marketing Information/Features in an attribute group. The attributes will not have a name. See Features and Specifications |
| specifications | List of Attribute Objects | Product specifications in attribute groups. The attributes will have a name. See Features and Specifications |
| downloads | List of File Object | Downloads in file groups |
| videos | List of File Objects | Videos in file groups |
| etim | ETIM Object | International classification standard for technical products. See ETIM Object |
| product_title | String | Manufacturer metadata title for product |
| long_description | String | Manufacturer long description of product |
| short_description | String | Manufacturer short description of product |
| invoice_description | String | Manufacturer invoice/order sheet description of product |
| rohs_indicator | String | Flag to identify product as RoHS. |
| family_code | String | Identifies a product Group or Family. Defined by each individual manufacturer |
| preferred_product | String | Manufacturer will identify a list products which are "preferred". An "X" signifies a preferred product |
| length | Double | Length of the product |
| length_uom | String | Abbreviation of the unit of measure for the length (standard or imperial based on the region id) |
| width | Double | Width of the product |
| width_uom | String | Abbreviation of the unit of measure for the length (standard or imperial based on the region id) |
| height | Double | Height of the product |
| height_uom | String | Abbreviation of the unit of measure for the length (standard or imperial based on the region id) |
| weight | Double | Weight of the product |
| weight_uom | String | Abbreviation of the unit of measure for the length (standard or imperial based on the region id) |
| sub_brand | String | Additional branding of the product |
| custom_keywords | String | Pipe delimited manufacturer keywords |
| prop_65_message | String | Warning given for products sold in California |
| ean | String | European Article Number |
| upc_11 | String | 11 Digit UPC |
| retail_flag | String | |
| country_of_origin | String | Country where the product was manufactured |
| abc_classification | String | |
| hazardous_material | String | Flag where product is distinguished as a hazardous material |
| manufacturer_product_group | String |
Images and Sizes
Images and Sizes
<name>DB300479_4000x4000.png</name>
<display_name>IMAGE</display_name>
<mime_type>image/png</mime_type>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/8f0721ce74a631bd2533af863d407dcd2e3de6d0-large.png</uri>
<sizes>
<thumb>
<length>3447</length>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/8f0721ce74a631bd2533af863d407dcd2e3de6d0-thumb.png</uri>
</thumb>
<small>
<length>6903</length>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/8f0721ce74a631bd2533af863d407dcd2e3de6d0-small.png</uri>
</small>
<medium>
<length>6903</length>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/8f0721ce74a631bd2533af863d407dcd2e3de6d0-medium.png</uri>
</medium>
<large>
<length>6903</length>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/8f0721ce74a631bd2533af863d407dcd2e3de6d0-large.png</uri>
</large>
<native>
<length>6903</length>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/8f0721ce74a631bd2533af863d407dcd2e3de6d0-native.png</uri>
</native>
</sizes>
We supply multiple sizes of the same image. This allows you to choose the size appropriate for your needs. All of our images are hosted on our Content Delivery Network(CDN) powered by Amazon CloudFront. There is no need to download and host the files yourself. Every file will be served from and secure HTTPS domain with a valid certificate.
Image Object
| Field Name | Data Type | Description |
|---|---|---|
| name | String | Often used for the filename attribute in the Content Disposition header |
| display_name | String | Usually shown as the text in the download link |
| mime_type | String | See Mozilla's documentation on Mime types here |
| weight | Integer | Used for sorting |
| uri | Sting | URI of the image on our CDN (https://media.distributordatasolutions.com/...) |
| sizes | Sizes Object | Object containing the parameters thumb, small, medium, large, and native |
Sizes Object
| Field Name | Data Type | Description |
|---|---|---|
| thumb | Size Object | Thumb Size Object. 64px x 62px Cropped*. Best for displaying in search results. |
| small | Size Object | Small Size Object. 256px x 256px Max*. Also good for displaying in search results or as the main image in your Product Details page. |
| medium | Size Object | Medium Size Object. 512px x 512px Max*. Good as the main Image in your Product Details Page. |
| large | Size Object | Large Size Object. 1024px x 1024px Max*. Good for a zoomed in version of the main image on the your Product Details page. |
| native | Size Object | Native Size Object. Original from manufacturer - Size varies. Good for a zoomed in version of the main image on your Product Details page. |
- "Max" will preserve the original aspect ratio of the image while "Cropped" will force the aspect ratio to a square image by cropping the longer sides
Size Object
| Field Name | Data Type | Description |
|---|---|---|
| uri | String | Fully qualified url of the image on our CDN. |
| length | Number | Size of the file in bytes. Not always present. Used to populate Content-length. |
Spec Sheet and SDS (Simple File Object)
Spec Sheet and Safety Data Sheet (SDS)
<name>ClimaSys_NSYCVF85M230PF.pdf</name>
<display_name>Product Datasheet (pdf)</display_name>
<mime_type>application/pdf</mime_type>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/722f89fc2e124968b7ebb3734d089b4f595ea7f7.pdf</uri>
<weight>10</weight>
Both the Spec Sheet and Safety data Sheet(SDS) have the same format.
| Field Name | Data Type | Description |
|---|---|---|
| name | String | Name of the file |
| display_name | String | Spec Sheet or Safety Data Sheet |
| mime_type | String | typically "application/pdf". See Mime Types |
| uri | String | URL of the file on our CDN |
| weight | Integer | value used for sorting |
Packages
Packages
# NOTICE. Many of the packaging fields are null and therfore excluded
<packages>
<package>
<gtin>00785901698654</gtin>
<gross_weight>0.84</gross_weight>
<gross_weight_uom>Lbs</gross_weight_uom>
</package>
</packages>
Package Object
| Field Name | Data Type | Description |
|---|---|---|
| code | String | Unique DDS hash for the package |
| gtin | String | Usually GTIN-14, however could be any GTIN. see www.gtin.info. |
| sub_gtin | String | If the package contains smaller packaging. This is the GTIN of those packages. |
| sub_qty | String | Number of "sub" packages |
| qty | String | Quantity |
| qty_uom | String | Quantity Unit of Measure |
| gross_weight | Number | Weight |
| gross_weight_uom | String | Weight Unit of Measure |
| pkg_length | Number | Length |
| pkg_length_uom | String | Length Unit of Measure |
| pkg_height | Number | Height |
| pkg_height_uom | String | Height Unit of Measure |
| pkg_width | Number | Width |
| pkg_width_uom | String | Width Unit of Measure |
| description | String | An explanation of the packaging |
| returnable | String | Indicates if the product is returnable or not |
Facets
Facets
# NOTICE. Some facets do not contain/require a uom and therefore omit the uom_unit_plural, uom_abbreviation, and uom_abbreviation_plural
<facets>
<facet>
<data_key>standard</data_key>
<name>Standard</name>
<values>
<value>
<facet_value>IEC 62208</facet_value>
<value_with_uom>IEC 62208</value_with_uom>
</value>
</values>
</facet>
<facet>
<data_key>weight</data_key>
<name>Weight</name>
<values>
<value>
<facet_value>38</facet_value>
<value_with_uom>38 kilograms</value_with_uom>
<uom_unit>kilogram</uom_unit>
<uom_unit_plural>kilograms</uom_unit_plural>
<uom_abbreviation>kg</uom_abbreviation>
<uom_abbreviation_plural>kg</uom_abbreviation_plural>
</value>
</values>
<values>
<value>
<facet_value>83.78</facet_value>
<value_with_uom>83.78 pounds</value_with_uom>
<uom_unit>pound</uom_unit>
<uom_unit_plural>pounds</uom_unit_plural>
<uom_abbreviation>lb</uom_abbreviation>
<uom_abbreviation_plural>lbs</uom_abbreviation_plural>
</value>
</values>
</facet>
</facets>
Facets are normalized and filterable attributes processed by our data team. They are extracted from product details and the unit of measure is separated, if applicable.
Facet Object
| Field Name | Data Type | Description |
|---|---|---|
| data_key | String | Uniquely identifies the facet |
| name | String | Display name |
| values | List of Facet value Objects | List of facet values |
Facet Value Object
| Field Name | Data Type | Description |
|---|---|---|
| facet_value | String | value without the unit of measure |
| value_with_uom | String | Value with the unit of measure added, considers pluralization |
| uom_unit | String | Singular text of the unit of measure |
| uom_unit_plural | Plural version of the unit of measure | |
| uom_abbreviation | Singular abbreviation of the unit of measure | |
| uom_abbreviation_plural | Plural version of abbreviation of the unit of measure |
Manufacturer/Distributor Categories
Manufacturer/Distributor Categories
<manufacturer_categories>
<category>
<category_id>445162</category_id>
<code>193c73ee12e172017850cbcb9025344e</code>
<name>Thermal Management</name>
<parent_id>443023</parent_id>
</category>
<category>
<category_id>443022</category_id>
<code>6289ca5fa1962a331a79fb511330eef0</code>
<name>Electrical Enclosures & Boxes</name>
</category>
<category>
<category_id>443023</category_id>
<code>b580b3d6dae788677ecddba162e2153c</code>
<name>Enclosure Accessories</name>
<parent_id>443022</parent_id>
</category>
</manufacturer_categories>
Manufacturer Categories provided directly from the manufacturer, or distributor specific categories and taxonomy.
Category Object
| Field Name | Data Type | Description |
|---|---|---|
| category_id | Integer | Unique ID for each category |
| code | String | UUID that uniquely identifies each category |
| name | String | Category name |
| parent_id | Integer | References the parent category_id |
360 Images
360 Images
<image_360>
<cols>24</cols>
<rows>1</rows>
<initial_image>https://media.distributordatasolutions.com/XXXXXXX/2021q2/360_images/medium/000014d91bcfa43ad4eacb2c6a2b670c9ce836ec-r01-c01-medium.png</initial_image>
<filename>000014d91bcfa43ad4eacb2c6a2b670c9ce836ec-r01-c01-medium.png</filename>
<initial_thumb>https://media.distributordatasolutions.com/XXXXXXX/2021q2/360_images/thumb/000014d91bcfa43ad4eacb2c6a2b670c9ce836ec-r01-c01-thumb.png</initial_thumb>
<filename_large>000014d91bcfa43ad4eacb2c6a2b670c9ce836ec-r01-c01-large.png</filename_large>
<format>ow-column</format>
<iframe_url>
<iframe src="https://media.distributordatasolutions.com/assets/magic360/viewer.html?initial=/xlsx_3M_synd/2021q1/360_images/medium/483ef5ff38ca15b34cd7debe629412e4583b5860-r01-c01-medium.png&filename=483ef5ff38ca15b34cd7debe629412e4583b5860-r{row}-c{col}-medium.png&rows=1&cols=24"></iframe>
</iframe_url>
<display_name>000014d91bcfa43ad4eacb2c6a2b670c9ce836ec 360 image</display_name>
</image_360>
Image 360 Object
| Field Name | Data Type | Description |
|---|---|---|
| cols | Integer | |
| rows | Integer | |
| initial_image | String | Naming convention of medium 360 image |
| filename | String | Category name |
| initial_thumb | String | URI for first of thumb sized 360 images |
| filename_large | String | Naming convention of large 360 images |
| format | String | Format of 360 images |
| iframe_url | String | Preconfigured 360 image viewer hosted by DDS. |
| display_name | String | Display name of image |
Example
iframe_urlusage
<iframe src="https://media.distributordatasolutions.com/assets/magic360/viewer.html?initial=/xlsx_3M_synd/2021q1/360_images/medium/483ef5ff38ca15b34cd7debe629412e4583b5860-r01-c01-medium.png&filename=483ef5ff38ca15b34cd7debe629412e4583b5860-r{row}-c{col}-medium.png&rows=1&cols=24"></iframe>
DDS has provided a simple integration where you can embed a 360 viewer in an iframe. You only need to set the iframe_url value as the src for the iframe.
Features and Specifications
Features and Specifications
<features>
<group>
<group_name>Warnings</group_name>
<group_items>
<item>
<value>NOT insulated. Will NOT protect against electrical shock.</value>
<weight>20</weight>
</item>
<item>
<value>Always wear approved eye protection.</value>
<weight>10</weight>
</item>
</group_items>
</group>
</features>
<specifications>
<group>
<group_name>Complementary</group_name>
<group_items>
<item>
<name>Absorbed Power</name>
<value>15 W 60 Hz || 17 W 50 Hz</value>
<weight>80</weight>
</item>
</group_items>
</group>
<group>
<group_name>Contractual Warranty</group_name>
<group_items>
<item>
<name>Warranty</name>
<value>18 months</value>
<weight>360</weight>
</item>
</group_items>
</group>
<group>
<group_name>Main</group_name>
<group_items>
<item>
<name>Flow Rate</name>
<value>Free flow rate with standard filter 22455.03 Gal/hr(US) (85 m3/h) 50 Hz || Free flow rate with standard filter 25889.32 Gal/hr(US) (98 m3/h) 60 Hz</value>
<weight>50</weight>
</item>
</group_items>
</group>
<group>
<group_name>Offer Sustainability</group_name>
<group_items>
<item>
<name>California Proposition 65</name>
<value>WARNING: This product can expose you to chemicals including: Lead and lead compounds, which is known to the State of California to cause cancer and birth defects or other reproductive harm. For more information go to www.p65warnings.ca.gov</value>
<weight>320</weight>
</item>
</group_items>
</group>
<group>
<group_name>Ordering And Shipping Details</group_name>
<group_items>
<item>
<name>Category</name>
<value>80036 - ENCLOSURE SYSTEMS ACCESSORIES</value>
<weight>260</weight>
</item>
</group_items>
</group>
</specifications>
Features and Specifications are delivered in grouped attributes. It is typical for manufactures to group their data in sub sections to add another level of context. Each group has a name and a list of attributes.
Features
Feature are typically displayed on manufactures sites as a bulleted list
Specifications
Specifications are typically displayed on a manufacture site in name value pairs, with the name bold and followed by a colon. Another method is to put the name value pairs in a table but is less common.
Group Object (Attributes)
| Field Name | Data Type | Description |
|---|---|---|
| group_name | String | Display name of the group |
| group_items | List of Attribute Objects | List of Attribute Objects that have name value pair |
Attribute Object
| Field Name | Data Type | Description |
|---|---|---|
| name | String | Display name for the attributes |
| value | String | Value |
| weight | Integer | Numeric value used for sorting/display. |
Downloads and Videos
Downloads and Videos
<downloads>
<group>
<group_items>
<item>
<name>SB200482_3D-simplified</name>
<display_name>Filterfan 85m3/h 230V IP54 (stp)</display_name>
<mime_type>application/step</mime_type>
<uri>https://media.distributordatasolutions.com/XXXXXXX/2019q3/51a1970b8fda1ed93500ecac7fb7c578990de424</uri>
<ext_hosted>0</ext_hosted>
<weight>90</weight>
<locale>en-US</locale>
<manufacturer_file_id>SB200482_3D-simplified</manufacturer_file_id>
</item>
</group_items>
</group>
</downloads>
<videos>
<group>
<group_items>
<item>
<name>Locating Coil Consumption Details on RXG Interface Relays</name>
<mime_type>text/html</mime_type>
<uri>https://www.youtube.com/embed/W6W-90ovcos</uri>
<ext_hosted>1</ext_hosted>
<weight>20</weight>
<locale>en-US</locale>
<description>Tutorial for locating the Coil Consumption Details</description>
</item>
</group_items>
</group>
</videos>
Group Object (Files)
| Field Name | Data Type | Description |
|---|---|---|
| group_items | List of File Objects | List of File Objects |
File Object
| Field Name | Data Type | Description |
|---|---|---|
| name | String | The name of the file |
| display_name | String | The display name for the file. Typically it is more human readable than the name. |
| mime_type | String | MimeType of the File |
| uri | String | Uri of the file or video. If ext_hosted is not 1, it will be hosted on our CDN. |
| ext_hosted | String | (Videos Only) 1 or null. If 1 use the "embedded_html" to display the video. |
| weight | Int | Used for sorting |
| description | String | a long description |
| duration | String | (Videos only) How long a Video is |
| embed_html | String | (Videos only) required when a video is hosted by an external provider (YouTube, Vimeo, etc...). |
Etim
Etim
<etim>
<group_code>EG00001</group_code>
<group_description>generic group</group_description>
<class_code>EC00001</class_code>
<class_description>generic class</class_description>
<version>7</version>
<features>
<feature>
<feature_code>EF000073</feature_code>
<value_code>EV009241</value_code>
<feature_name>Suitable for</feature_name>
</feature>
<feature>
<feature_code>EF007092</feature_code>
<value_string>25</value_string>
<unit_code>EU570448</unit_code>
<feature_name>Width clamp</feature_name>
<unit_name>Millimetre</unit_name>
</feature>
</features>
</etim>
ETIM Object
| Field Name | Data Type | Description |
|---|---|---|
| group_code | String | ETIM code for the group to which the product belongs |
| group_description | String | Name of ETIM group to which the product belongs |
| class_code | String | ETIM code for the class within the group to which the product belongs |
| class_description | String | ETIM description for the class within the group to which the product belongs |
| version | String | ETIM verions |
| features | List of Feature Object | See Feature Object |
Feature Object
| Field Name | Data Type | Description |
|---|---|---|
| feature_code | String | ETIM feature code |
| value_string | String | Value for feature if not a code |
| unit_code | String | ETIM uom code |
| feature_name | String | Name of the feature |
| unit_name | String | Name of the unit of measure |
File Delivery
Files will be delivered over SFTP. DDS will provide a username and password that will allow access to the host sftp.distds.com
A decent, free option is FileZilla.
After starting FileZilla, click the Site Manager button. 
In the Site Manager, click the "New Site" button. 
Immediately type in a name that will help you remember the site, like "DDS", then hit return. Click the protocol selection button, and select "SFTP - SSH File Transfer Protocol". For the host, enter "sftp.distds.com". For the port, enter 22. The "Normal" logon type will work for us, and enter the user name and password given to you by DDS. Click "Connect".
FileZilla will then ask you if you want to save passwords. You should follow your company policies with regard to this. If you select "Save passwords", FileZilla will save your passwords, this being the least secure but most convenient option. If you select "Do not save passwords", the password will not be saved between sessions, and you will need to re-enter it when you reconnect. If you select "Save passwords protected by a master password", all passwords entered into FileZilla will be saved, but to use them, you will need to enter a master password. This would enable you to protect the password provided by DDS with one of your own.
As part of the secure connection process, the server will provide a key to prove its identity. If the key fingerprints match the following, you should click "Always trust this host", then "OK".
At this point, you will have a connection to our SFTP server. You should drop files for us in the folder to-dds, and we will provide files to you in the folder from-dds.
Future connections can be made by opening the Connection Manager again, selecting the DDS connection, then clicking "Connect".