Product metadata

This section describes various metadata that is available for the products.

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

{
    "product": {
        "metadata": {
            "apparel": { /* ... */ },
            "electric": { /* ... */ },
            "externalIds": { /* ... */ },
            "food": { /* ... */ },
            "generic": { /* ... */ },
            "media": { /* ... */ },
            "printBook": { /* ... */ }
        }
    }
}

Generic objects

Measurement object

Measurement represents quantitative metadata values such as weights, sizes, dimensions, volumes, or amounts.

Measurement is a mapping of one or more comparison operators to value objects.

Currently supported operators are: equals, lessThan, greaterThan.

Each value object consists of:

  • value — the measurement value, represented as a string to preserve precision,
  • unit — the unit in which the value is expressed.
// 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"
    }
}