OptionSet.detailed

Field Type Description
id Int Id of the option set
name String Name of the option set (translated)
code String? Nullable. ID or key that you a third party can associate with an option set
multiple_choice Bool If true, the user can select none, one or more options (min_different_options and max_different_options is used for minimum and maximum)
choose_amount Bool If true, the user can enter an amount for every option. Note that this can only get enabled when multiple_choice = true
min_different_options Int When multiple choice is enabled, this is the minimum of different options a user should add to a cart item
max_different_options Int? Nullable. When multiple choice is enabled, this is the maximum of different options a user should add to a cart item. When set to null, there is no limit
min_amount_options Int When choose_amount is enabled, this is the minimum allowed sum of the option amounts user should add to a cart item. Note: if price per person is used, you should multiply this amount with the chosen persons.
max_amount_options Int? Nullable. When choose_amount is enabled, this is the maximum allowed sum of the option amounts a user should add to a cart item. When set to null, there is no limit. Note: if price per person is used, you should multiply this amount with the chosen persons.
options [Option.simple] Array of Option.simple

Examples

Example 1

{
    "id": 15,
    "name": "...",
    "code": "...",
    "multiple_choice": false,
    "choose_amount": false,
    "min_different_options": 12,
    "max_different_options": 16,
    "min_amount_options": 18,
    "max_amount_options": 11,
    "options": [
        {
            "id": 15,
            "name": "...",
            "price_change": {
                "value": 10,
                "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": false
            },
            "require_image": false,
            "code": "...",
            "price_calculation": "PER_PIECE"
        },
        {
            "id": 12,
            "name": "...",
            "price_change": {
                "value": 13,
                "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": false
            },
            "require_image": true,
            "code": "...",
            "price_calculation": "PER_PIECE"
        },
        {
            "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
                    }
                ],
                "white_background": false
            },
            "require_image": false,
            "code": "...",
            "price_calculation": "PER_PIECE"
        }
    ]
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.7.0 stable