Option.detailed

Field Type Description
id Int Id of the product price
name String Name of the product price (translated)
price_change Price Price change in cents. Positive for price increase, negative for discount.
image Image? Nullable.
require_image Bool A boolean value
code String? Nullable. ID or key that you a third party can associate with an option
price_calculation String How to multiply the price_change with the amount, kg or persons of a cart item
optionset OptionSet.simple

Examples

Request

When used inside a request.

Example 1

{
    "id": 17,
    "name": "...",
    "price_change": {
        "value": 19,
        "currency": "EUR"
    },
    "image": {
        "resolutions": [
            {
                "src": "https://example.com",
                "width": 600,
                "height": 350
            },
            {
                "src": "https://example.com",
                "width": 600,
                "height": 350
            },
            {
                "src": "https://example.com",
                "width": 600,
                "height": 350
            }
        ],
        "white_background": true
    },
    "require_image": true,
    "code": "...",
    "price_calculation": "PER_PIECE",
    "optionset": {
        "id": 16,
        "name": "...",
        "code": "...",
        "multiple_choice": true,
        "choose_amount": false,
        "min_different_options": 19,
        "max_different_options": 13,
        "min_amount_options": 19,
        "max_amount_options": 19
    }
}

Response

When returned in a response.

Example 1

{
    "id": 17,
    "name": "...",
    "price_change": {
        "value": 15,
        "currency": "EUR"
    },
    "image": {
        "resolutions": [
            {
                "src": "https://example.com",
                "width": 600,
                "height": 350
            },
            {
                "src": "https://example.com",
                "width": 600,
                "height": 350
            },
            {
                "src": "https://example.com",
                "width": 600,
                "height": 350
            }
        ],
        "file_id": 19,
        "white_background": false
    },
    "require_image": false,
    "code": "...",
    "price_calculation": "PER_PIECE",
    "optionset": {
        "id": 19,
        "name": "...",
        "code": "...",
        "multiple_choice": false,
        "choose_amount": false,
        "min_different_options": 13,
        "max_different_options": 11,
        "min_amount_options": 12,
        "max_amount_options": 19
    }
}
This is a development version Do not use this version in production
1.10.0 development