company.OptionSet.detailed

Request

Fields when send to the api inside a request.

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
code String? Optional. Nullable. Your own ID or key that you can associate with an option set

Response

Fields when returned by the api in a response.

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

Examples

Request

When used inside a request.

Example 1

{
    "id": 777,
    "name": {
        "nl": "Do you want a bag?"
    },
    "allow_attachment": false,
    "code": null,
    "options": [
        {
            "id": 2730,
            "name": {
                "nl": "Yes"
            },
            "price_change": 375,
            "code": null,
            "order": 1
        },
        {
            "id": 2731,
            "name": {
                "nl": "Yes please"
            },
            "price_change": 775,
            "code": null,
            "order": 2
        },
        {
            "id": 2732,
            "name": {
                "nl": "Yes"
            },
            "price_change": 170,
            "code": null,
            "order": 3
        }
    ]
}

Example 2

{
    "id": 778,
    "name": {
        "nl": "Do you want your bread sliced?"
    },
    "allow_attachment": false,
    "code": null,
    "options": [
        {
            "id": 2733,
            "name": {
                "nl": "Yes"
            },
            "price_change": 980,
            "code": null,
            "order": 1
        },
        {
            "id": 2734,
            "name": {
                "nl": "No"
            },
            "price_change": 725,
            "code": null,
            "order": 2
        },
        {
            "id": 2735,
            "name": {
                "nl": "No thank you"
            },
            "price_change": 648,
            "code": null,
            "order": 3
        }
    ]
}

Response

When returned in a response.

Example 1

{
    "id": 779,
    "name": {
        "nl": "Extra baked?"
    },
    "allow_attachment": false,
    "code": null,
    "options": [
        {
            "id": 2736,
            "name": {
                "nl": "No"
            },
            "price_change": 327,
            "code": null,
            "order": 1
        },
        {
            "id": 2737,
            "name": {
                "nl": "No"
            },
            "price_change": 76,
            "code": null,
            "order": 2
        },
        {
            "id": 2738,
            "name": {
                "nl": "Yes please"
            },
            "price_change": 941,
            "code": null,
            "order": 3
        },
        {
            "id": 2739,
            "name": {
                "nl": "No thank you"
            },
            "price_change": 832,
            "code": null,
            "order": 4
        },
        {
            "id": 2740,
            "name": {
                "nl": "No"
            },
            "price_change": 579,
            "code": null,
            "order": 5
        }
    ]
}

Example 2

{
    "id": 780,
    "name": {
        "nl": "Please select an option"
    },
    "allow_attachment": false,
    "code": null,
    "options": [
        {
            "id": 2741,
            "name": {
                "nl": "Yes"
            },
            "price_change": 32,
            "code": null,
            "order": 1
        },
        {
            "id": 2742,
            "name": {
                "nl": "No thank you"
            },
            "price_change": 628,
            "code": null,
            "order": 2
        },
        {
            "id": 2743,
            "name": {
                "nl": "No"
            },
            "price_change": 792,
            "code": null,
            "order": 3
        }
    ]
}
1.5.0 stable