API documentation

Generic product metadata

Represents generic product metadata, not specific to any product category.

Metadata attribute name	Relevance	Products count
colors	All products.	10 417 760
contributors	Books, video and audio recordings.	11 163 770
dimensions	All physical products.	9 652 670
genderFit	Products designed for a particular gender.	1 618 683
ingredients	Products with a clearly defined ingredient or material composition.	5 930 678
manufacturerCode	All products.	9 592 515
numberOfItems	All products.	889 222
power	Products with a measurable power rating.	62 314
recommendedAge	Products whose suitability depends on the user’s age, such as toys, games, or age-restricted products.	578 747
storageConditions	All physical products.	339 632
volume	Products that have a defined physical volume or capacity.	780 978
weight	All physical products.	4 913 891

generic.colors

Describes the product color and is represented by a list of color objects. Each object consists of a baseColor attribute and an optional shade attribute, both of which are strings.

{
    "product": {
        "metadata": {
            "generic": {
                "colors": [
                    {"baseColor": "blue", "shade": "light"},
                    {"baseColor": "black"}
                ]
            }
        }
    }
}

Supported baseColor values.
- aluminium
- beige
- black
- blue
- bronze
- brown
- chrome
- copper
- cream
- cyan
- gold
- gray
- green
- ivory
- khaki
- magenta
- multi
- orange
- pink
- purple
- red
- silver
- steel
- transparent
- turquoise
- violet
- white
- wood
- yellow

Supported shade values.
- light
- dark
- medium
- matte
- gloss
- neon
- metallic
- fluorescent
- bright
- warm
- cold

generic.contributors

Product contributors (book authors, music performers, etc.), a list of objects. Each contributor object has following attributes:

names — "lang" → "contributor" mapping
type — contributor type, string, one of the following:
- author , editor , narrator , translator, visual_artist — for print and audio books
- artist — artist (for music recordings: composer / musician etc.)
- music_group — music group / band
- choir — choir / chorus / large vocal ensemble
- orchestra — large instrumental ensemble

{
    "product": {
        "metadata": {
            "generic": {
                "contributors": [
                    {
                        "names": {
                            "en": "John Smith"
                        },
                        "type": "author"
                    },
                    {
                        "names": {
                            "en": "Paul Jones"
                        },
                        "type": "editor"
                    }
                ]
            }
        }
    }
}

generic.dimensions

Product and packaging dimensions information. Product dimensions are represented by dimensions.product field, packaging dimensions — by dimensions.packaging . Each field can contain width, height, depth or length attributes, depending on the configuration of the product. Each of these attributes is a Measurement object.

"dimensions": {
    // 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",
                "unit": "cm"  // Supported values: ["cm"]
            }
        },
        "height": {
            "equals": {
                "value": "19.5",
                "unit": "cm"
            }
        }
        // ...
    },
    // Packaging dimensions, if available
    "packaging": {
        // Same structure as for product dimensions
    }
}

generic.genderFit

Gender fit of a product, string. Can be one of the following values: male, female, unisex.

generic.ingredients

Product ingredients or materials. See Product ingredients for detailed information.

generic.manufacturerCode

Manufacturer product code, string.

generic.numberOfItems

Number of individual items that are included in the product as sold, a Measurement object.

generic.power

Mechanical or electrical product power (in watts), a Measurement object.

"power": {
    "equals": {
        "value": "750",
        "unit": "watt"
    }
}

generic.recommendedAge

Product's recommended age, a Measurement object. Most often contains a range, for example, 2-5 years or 18+ years.

"recommendedAge": {
    "greaterThan": {
        "value": "18",
        "unit": "year"
    }
}

generic.storageConditions

An object, describing product storage conditions. See Storage conditions for detailed information.

generic.volume

Product volume information, a Measurement object.

"volume": {
    "equals": {
        "value": "100",  // Volume value, floating point number
        "unit": "ml"     // Supported values: ["ml"]
    }
}

generic.weight

Product weight information, an object containing a combination of the following fields: net (net weight), gross (gross weight) or unknown (when we lack information whether it's net or gross weight). Each field is a Measurement object.

"weight": {
    "net": {
        "equals": {
            "value": "150",  // Weight value, floating point number
            "unit": "grams"  // Supported values: ["grams"]
        }
    },
    "gross": {
        "equals": {
            "value": "200",
            "unit": "grams"
        }
    }
}