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

{
    "name": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "allow_attachment": true,
    "options": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "price_change": 18,
            "order": 17
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "price_change": 14,
            "order": 10
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "price_change": 14,
            "order": 13
        }
    ]
}

Response

When returned in a response.

Example 1

{
    "name": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "allow_attachment": false,
    "options": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "price_change": 13,
            "id": 11,
            "order": 10
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "price_change": 13,
            "id": 13,
            "order": 12
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "price_change": 17,
            "id": 10,
            "order": 18
        }
    ],
    "id": 16
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.4.0 stable