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

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

Examples

Request

When used inside a request.

Example 1

{
    "id": 3469,
    "name": {
        "nl": "Do you want your bread sliced?"
    },
    "allow_attachment": false,
    "options": [
        {
            "id": 12183,
            "name": {
                "nl": "No thank you"
            },
            "price_change": 323,
            "order": 1
        },
        {
            "id": 12184,
            "name": {
                "nl": "Yes"
            },
            "price_change": 834,
            "order": 2
        },
        {
            "id": 12185,
            "name": {
                "nl": "Yes please"
            },
            "price_change": 852,
            "order": 3
        }
    ]
}

Example 2

{
    "id": 3470,
    "name": {
        "nl": "Extra baked?"
    },
    "allow_attachment": false,
    "options": [
        {
            "id": 12186,
            "name": {
                "nl": "Yes"
            },
            "price_change": 258,
            "order": 1
        },
        {
            "id": 12187,
            "name": {
                "nl": "No thank you"
            },
            "price_change": 283,
            "order": 2
        },
        {
            "id": 12188,
            "name": {
                "nl": "Yes"
            },
            "price_change": 777,
            "order": 3
        },
        {
            "id": 12189,
            "name": {
                "nl": "Yes"
            },
            "price_change": 392,
            "order": 4
        }
    ]
}

Response

When returned in a response.

Example 1

{
    "id": 3471,
    "name": {
        "nl": "Please select an option"
    },
    "allow_attachment": false,
    "options": [
        {
            "id": 12190,
            "name": {
                "nl": "Yes"
            },
            "price_change": 646,
            "order": 1
        },
        {
            "id": 12191,
            "name": {
                "nl": "No"
            },
            "price_change": 850,
            "order": 2
        },
        {
            "id": 12192,
            "name": {
                "nl": "No"
            },
            "price_change": 386,
            "order": 3
        }
    ]
}

Example 2

{
    "id": 3472,
    "name": {
        "nl": "Do you want a bag?"
    },
    "allow_attachment": false,
    "options": [
        {
            "id": 12193,
            "name": {
                "nl": "No thank you"
            },
            "price_change": 138,
            "order": 1
        },
        {
            "id": 12194,
            "name": {
                "nl": "Yes"
            },
            "price_change": 441,
            "order": 2
        },
        {
            "id": 12195,
            "name": {
                "nl": "Yes"
            },
            "price_change": 104,
            "order": 3
        },
        {
            "id": 12196,
            "name": {
                "nl": "No"
            },
            "price_change": 284,
            "order": 4
        }
    ]
}
Version update available Please adjust your integration to the latest stable version (1.5.0)
1.2.0 stable