API docs

Product metadata

This section describes various metadata that may be available for products.

Metadata availability and contents may vary depending on the product type. At the moment several types of metadata may be available:

Generic objects:

metadata.generic — generic metadata

Generic metadata may contain these fields:

Name and countDescription
generic.colors
(10 388 654 products)		 Product color, an array of objects. See Product colors for the list of supported values and an example.
generic.contributors
(10 915 400 products)		 Product contributors (book authors, music performers, etc.), a list of objects. Each contributor object has following attributes:
  • names — "lang" → "contributor name / title" mapping
  • type — contributor type, string, one of the following:
    • author — book author
    • narrator — audio book narrator
    • translator — book translator
    • artist — artist (for music recordings: composer / musician etc.)
    • music_group — music group / band
    • choir — choir / chorus / large vocal ensemble
    • orchestra — large instrumental ensemble
generic.dimensions
(9 573 320 products)		 Product and packaging dimensions information, an object: 
{
    // Product dimensions, if available
    "product": {
        // Can contain "width", "height", "depth" and / or "length" attributes
        // Each attribute is a Measurement object
        "width": {
            "equals": {
                "value": 9.5, // Dimension value
                "unit": "cm"  // Supported values: ["cm"]
            }
        },
        // ...
        "depth": {
            "equals": {
                "value": 19.5,
                "unit": "cm"
            }
        }
    },
    // Packaging dimensions, if available
    "packaging": {
        // ... same structure as for product dimensions
    }
}
generic.genderFit
(1 610 210 products)		 Gender fit of a product, string. Can be one of the following values: male, female, unisex.
generic.ingredients
(5 930 611 products)		 Product ingredients or materials. See Product ingredients for detailed information.
generic.manufacturerCode
(9 592 563 products)		 Manufacturer product code, string.
generic.numberOfItems
(889 221 products)		 Number of individual items that are included in the product as sold, a Measurement object.
generic.power
(12 040 products)		 Product power (in watts), a Measurement object. 
{
    "equals": {
        "value": 750,
        "unit": "watts"
    }
}
generic.recommendedAge
(491 563 products)		 Product's recommended age, a Measurement object. Most often contains a range, for example, 2-5 years or 18+ years. 
{
    "greaterThan": {
        "value": 18,
        "unit": "year"
    }
}
generic.storageConditions
(182 268 products)		 An object, describing product storage conditions. Can contain the following keys:
  • shelfLife — product shelf life, a Measurement object. Valid units: hour, day, week, month, year.
  • temperature — recommended product storage temperature, a Measurement object. Valid unit: degree_celsius. Often contains ranges (lessThan and greaterThan).
  • humidity — recommended product storage humidity, a Measurement object. Valid unit: percent. Often contains ranges (lessThan and greaterThan).
  • recommendations — other recommendations, an array of strings. Possible values: cool_place, dark_place, dry_place, avoid_direct_sunlight, refrigerate_after_opening, do_not_freeze, room_temperature.
"storageConditions" : {
    "shelfLife" : {
        "equals" : {
            "value" : "6",
            "unit" : "month"  // supported values: ["hour", "day", "week", "month", "year"]
        }
    },
    "temperature" : {
        "greaterThan" : {
              "value" : "5",
              "unit" : "degree_celsius"
        },
        "lessThan" : {
            "value" : "22",
            "unit" : "degree_celsius"
        }
    },
    "humidity" : {
        "lessThan" : {
            "value" : "75",
            "unit" : "percent"
        }
    },
    "recommendations": ["avoid_direct_sunlight", "refrigerate_after_opening"]
}
generic.volume
(780 975 products)		 Product volume information, a Measurement object. 
{
    "equals": {
        "value": 100,  // Volume value, float
        "unit": "ml"   // Supported values: ["ml"]
    }
}
generic.weight
(4 759 440 products)		 Product weight information, a mapping of net (for net weight), gross (for gross weight) or unknown (when we lack information whether it's net or gross weight) to a Measurement object: 
{
    "net": {
        "equals": {
            "value": 150.0,  // Weight value, float
            "unit": "grams"  // Supported values: ["grams"]
        }
    },
    "gross": {
        "equals": {
            "value": 200.0,
            "unit": "grams"
        }
    }
}

An example of generic metadata:

{
    // ...
    "product": {
        "metadata": {
            "generic": {
                "manufacturerCode": "PRODUCT-CODE-123",
                "colors": ["white"],
                "contributors": [
                    {
                        "names": {
                            "en": "John Smith"
                        },
                        "type": "author"
                    }
                ]
            }
        }
    }
}

metadata.apparel — shoes, clothing and other apparel products

Apparel products metadata may contain following fields:

Name and countDescription
apparel.sizes
(320 739 products)		 The apparel_sizes field is an array containing one or more Measurement objects. Each object specifies a size using one of the following units:
  • size_label — for standard clothing size labels (XXS, XS, S, M, L, XL, XXL, XXXL, XXXXL, one_size)
  • eu_shoe_size — for European shoe sizes
  • us_shoe_size — for US shoe sizes
A garment with size XS: 
[{
    "equals": {"value": "XS", "unit": "size_label"}
}]
A pair of shoes with US and EU sizes: 
[{
    "equals": {"value": "8", "unit": "us_shoe_size"}
}, {
    "equals": {"value": "41", "unit": "eu_shoe_size"}
}]

metadata.electric — electric products

Electric products metadata may contain these fields:

Name and countDescription
electric.voltage
(40 086 products)		 Product voltage (in volts), a Measurement object. 
{
    "equals": {
        "value": 1.5,
        "unit": "volts"
    }
}

metadata.externalIds — product ids in external sources

External ids metadata may contain these fields:

Name and countDescription
externalIds.amazonAsin
(1 268 045 products)		 Amazon Standard Identification Number, string.

An example of external ids metadata:

{
    // ...
    "product": {
        "metadata": {
            "externalIds": {
                "amazonAsin": "AMAZONASIN"
            }
        }
    }
}

metadata.food — food items and beverages

Food metadata may contain these fields:

Name and countDescription
food.nutrimentsPer100Grams
(1 236 295 products)		 Food nutriments information. See Food nutriments for detailed information.
food.nutriScore
(743 308 products)		 Product Nutri-Score, an object: 
{
    "score": 1,   // Nutri-Score, an integer
    "grade": "B"  // Nutri-Score letter grade (from "A" to "E")
}

An example of food metadata:

{
    // ...
    "product": {
        "metadata": {
            "food": {
                "nutrimentsPer100Grams": {
                    "fat": {
                        "equals": {
                            "value": 1.0,
                            "unit": "grams"
                        }
                    },
                    "proteins": {
                        "equals": {
                            "value": 12.0,
                            "unit": "grams"
                        }
                    },
                    "energy": {
                        "equals": {
                            "value": 654,
                            "unit": "kcal"
                        }
                    },
                },
                "nutriScore": {
                    "score": 1,
                    "grade": "B"
                }
            }
        }
    }
}

metadata.printBook — print books

Print book metadata may contain these fields:

Name and countDescription
printBook.numPages
(8 351 574 products)		 Number of pages in print book, integer.
printBook.bisacCodes
(1 240 066 products)		 BISAC codes of a print book, list of strings.
printBook.bindingType
(9 343 503 products)		 Book binding type, one of strings: hardcover, paperback.

An example of print book metadata:

{
    // ...
    "product": {
        "metadata": {
            "printBook": {
                "numPages": 123,
                "bisacCodes": ["FIC027110"],
                "bindingType": "paperback"
            }
        }
    }
}

metadata.media — books, music and other media products

Media products metadata, relevant for digital or physical books, newspapers, magazines, music and sound recordings. May contain following fields:

Name and countDescription
media.publicationYear
(13 790 600 products)		 Media product publication or release year, integer. In case of re-issues that use the same barcode, this is the year of the first publication. For on-demand publications, this is the year of the original publication.

An example of media metadata:

{
    // ...
    "product": {
        "metadata": {
            "media": {
                "publicationYear": 1990
            }
        }
    }
}

Measurement object

Measurement represents various measurements (weights, sizes, amounts, dimensions) for metadata properties values.

It is a mapping of one or several measures (currently supported: equals, lessThan, greaterThan) to value objects. Each value object consists of value field that holds a numeric or a string measurement and unit field, containing the unit in which this measurement is represented.

// Precise measurement example
{
    "equals": {
        "value": 12.5,
        "unit": "ml"
    }
}

// Measurement range example
{
    "greaterThan": {
        "value": 10,
        "unit": "mg"
    },
    "lessThan": {
        "value": 20,
        "unit": "mg"
    }
}

// String measurement value example
{
    "equals": {
        "value": "XS",
        "unit": "size_label"
    }
}
© 2024 EAN-DB DOO, support@ean-db.com
Terms of Service · Privacy policy · Cookie policy · Consent Preferences