Get all the option sets that belong to a company

GET /company/companies/@id/optionsets

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 Company ID. Return only option sets of this company

Example request 1 Retrieve optionsets

GET /company/companies/164/optionsets HTTP/1.1
Host: api.bakeronline.be
Authorization: Bearer ddb51b4c7f4eb287ffe9f10904f82f4cc426be57ea5d009d5b3a839d2da35c57162ab514511dc1258116217f344b787e97020ed500e713c17e7568fb35c8c1f0e3d652d4665908b1f2fd292905a4a823d087d2726745c225e100d136735748578d8d7537
X-VERSION: 1.5.0
Accept-Language: en-US,en;q=0.5

Response

Array of company.OptionSet.detailed: [company.OptionSet.detailed]

company.OptionSet.detailed

Field Type Description
name [Language: String] Name of the option set
allow_attachment Bool Allow the attachment of a picture to this option set
options [company.Option] Array of company.Option
id Int Id of the option set
code String? Nullable. Your own ID or key that you can associate with an option set

Example response 1 Retrieve optionsets

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

[
    {
        "id": 447,
        "name": {
            "nl": "Do you want a picture on your cake?"
        },
        "allow_attachment": false,
        "code": null,
        "options": [
            {
                "id": 1566,
                "name": {
                    "nl": "Yes please"
                },
                "price_change": 404,
                "code": null,
                "order": 1
            },
            {
                "id": 1567,
                "name": {
                    "nl": "No"
                },
                "price_change": 121,
                "code": null,
                "order": 2
            },
            {
                "id": 1568,
                "name": {
                    "nl": "Yes please"
                },
                "price_change": 403,
                "code": null,
                "order": 3
            },
            {
                "id": 1569,
                "name": {
                    "nl": "No"
                },
                "price_change": 720,
                "code": null,
                "order": 4
            }
        ]
    },
    {
        "id": 448,
        "name": {
            "nl": "Do you want a bag?"
        },
        "allow_attachment": false,
        "code": null,
        "options": [
            {
                "id": 1570,
                "name": {
                    "nl": "No"
                },
                "price_change": 765,
                "code": null,
                "order": 1
            },
            {
                "id": 1571,
                "name": {
                    "nl": "No thank you"
                },
                "price_change": 438,
                "code": null,
                "order": 2
            },
            {
                "id": 1572,
                "name": {
                    "nl": "Yes please"
                },
                "price_change": 527,
                "code": null,
                "order": 3
            },
            {
                "id": 1573,
                "name": {
                    "nl": "Yes"
                },
                "price_change": 369,
                "code": null,
                "order": 4
            }
        ]
    },
    {
        "id": 449,
        "name": {
            "nl": "Do you want a picture on your cake?"
        },
        "allow_attachment": false,
        "code": null,
        "options": [
            {
                "id": 1574,
                "name": {
                    "nl": "Yes please"
                },
                "price_change": 836,
                "code": null,
                "order": 1
            },
            {
                "id": 1575,
                "name": {
                    "nl": "No thank you"
                },
                "price_change": 740,
                "code": null,
                "order": 2
            },
            {
                "id": 1576,
                "name": {
                    "nl": "Yes"
                },
                "price_change": 832,
                "code": null,
                "order": 3
            },
            {
                "id": 1577,
                "name": {
                    "nl": "No"
                },
                "price_change": 492,
                "code": null,
                "order": 4
            }
        ]
    },
    {
        "id": 450,
        "name": {
            "nl": "Do you want a bag?"
        },
        "allow_attachment": false,
        "code": null,
        "options": [
            {
                "id": 1578,
                "name": {
                    "nl": "Yes"
                },
                "price_change": 435,
                "code": null,
                "order": 1
            },
            {
                "id": 1579,
                "name": {
                    "nl": "No"
                },
                "price_change": 398,
                "code": null,
                "order": 2
            },
            {
                "id": 1580,
                "name": {
                    "nl": "No"
                },
                "price_change": 728,
                "code": null,
                "order": 3
            },
            {
                "id": 1581,
                "name": {
                    "nl": "No"
                },
                "price_change": 577,
                "code": null,
                "order": 4
            },
            {
                "id": 1582,
                "name": {
                    "nl": "Yes please"
                },
                "price_change": 250,
                "code": null,
                "order": 5
            }
        ]
    },
    {
        "id": 451,
        "name": {
            "nl": "Please select an option"
        },
        "allow_attachment": false,
        "code": null,
        "options": [
            {
                "id": 1583,
                "name": {
                    "nl": "No thank you"
                },
                "price_change": 536,
                "code": null,
                "order": 1
            },
            {
                "id": 1584,
                "name": {
                    "nl": "Yes please"
                },
                "price_change": 630,
                "code": null,
                "order": 2
            },
            {
                "id": 1585,
                "name": {
                    "nl": "Yes"
                },
                "price_change": 826,
                "code": null,
                "order": 3
            },
            {
                "id": 1586,
                "name": {
                    "nl": "Yes"
                },
                "price_change": 945,
                "code": null,
                "order": 4
            }
        ]
    }
]
1.5.0 stable