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": 4905,
    "name": {
        "en": "Do you want a bag?"
    },
    "allow_attachment": false,
    "options": [
        {
            "id": 17157,
            "name": {
                "en": "Yes please"
            },
            "price_change": 546,
            "order": 1
        },
        {
            "id": 17158,
            "name": {
                "en": "Yes"
            },
            "price_change": 512,
            "order": 2
        },
        {
            "id": 17159,
            "name": {
                "en": "Yes please"
            },
            "price_change": 470,
            "order": 3
        }
    ]
}

Example 2

{
    "id": 4906,
    "name": {
        "en": "Please select an option"
    },
    "allow_attachment": false,
    "options": [
        {
            "id": 17160,
            "name": {
                "en": "Yes please"
            },
            "price_change": 94,
            "order": 1
        },
        {
            "id": 17161,
            "name": {
                "en": "Yes"
            },
            "price_change": 364,
            "order": 2
        },
        {
            "id": 17162,
            "name": {
                "en": "Yes"
            },
            "price_change": 29,
            "order": 3
        },
        {
            "id": 17163,
            "name": {
                "en": "Yes"
            },
            "price_change": 874,
            "order": 4
        },
        {
            "id": 17164,
            "name": {
                "en": "Yes please"
            },
            "price_change": 51,
            "order": 5
        }
    ]
}

Response

When returned in a response.

Example 1

{
    "id": 4907,
    "name": {
        "en": "Do you want a picture on your cake?"
    },
    "allow_attachment": false,
    "options": [
        {
            "id": 17165,
            "name": {
                "en": "Yes please"
            },
            "price_change": 755,
            "order": 1
        },
        {
            "id": 17166,
            "name": {
                "en": "Yes"
            },
            "price_change": 498,
            "order": 2
        }
    ]
}

Example 2

{
    "id": 4908,
    "name": {
        "en": "Do you want a bag?"
    },
    "allow_attachment": false,
    "options": [
        {
            "id": 17167,
            "name": {
                "en": "Yes"
            },
            "price_change": 856,
            "order": 1
        },
        {
            "id": 17168,
            "name": {
                "en": "Yes please"
            },
            "price_change": 820,
            "order": 2
        },
        {
            "id": 17169,
            "name": {
                "en": "Yes"
            },
            "price_change": 302,
            "order": 3
        },
        {
            "id": 17170,
            "name": {
                "en": "No"
            },
            "price_change": 420,
            "order": 4
        },
        {
            "id": 17171,
            "name": {
                "en": "No"
            },
            "price_change": 275,
            "order": 5
        }
    ]
}
Version update available Please adjust your integration to the latest stable version (1.3.0)
1.0.0 stable