Get all the options that belong to an option set

GET /company/optionsets/@id/options

Request

Authentication

This endpoint requires authentication.

Header Value
Authorization Set the value to Bearer + + access_token

URL parameters

Replace the @ keywords in the URL with their corresponding value.

A dictionary with fields

Field Type Description
id Int Option set ID. Return only options of this option set

Example request 1

GET /company/optionsets/17/options HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.10.0
Accept-Language: en-US,en;q=0.5

Response

Array of company.Option: [company.Option]

company.Option

Field Type Description
name [Language: String] Name of the option
price_change Int Price change in cents. Positive for price increase, negative for discounts.
id Int ID of this option
code String? Nullable. Your own ID or key that you can associate with an option
order Int The options of a option set are sorted on the order property (descending). If you specify the same order for multiple option sets, the id of the option set is used. Setting the same order for all option sets is discouraged.
price_calculation String How to multiply the price_change with the amount, kg or persons of a cart item
active Bool Optional. Is the option active or not?
image Image? Optional. Nullable.

Example response 1

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 2624

[
    {
        "name": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "price_change": 13,
        "id": 18,
        "code": "...",
        "order": 11,
        "price_calculation": "PER_PIECE",
        "active": true,
        "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": 17,
            "white_background": true
        }
    },
    {
        "name": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "price_change": 19,
        "id": 16,
        "code": "...",
        "order": 14,
        "price_calculation": "PER_PIECE",
        "active": false,
        "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": 16,
            "white_background": false
        }
    },
    {
        "name": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "price_change": 12,
        "id": 13,
        "code": "...",
        "order": 11,
        "price_calculation": "PER_PIECE",
        "active": false,
        "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": 15,
            "white_background": true
        }
    }
]
This is a development version Do not use this version in production
1.10.0 development