company.OptionSet.simple

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
code String? Optional. Nullable. Your own ID or key that you can associate with an option set
multiple_choice Bool Optional. If true, the user can select none, one or more options (min_different_options and max_different_options is used for minimum and maximum)
choose_amount Bool Optional. If true, the user can enter an amount for every option. Note that this can only get enabled when multiple_choice = true
min_different_options Int Optional. When multiple choice is enabled, this is the minimum of different options a user should add to a cart item
max_different_options Int? Optional. Nullable. When multiple choice is enabled, this is the maximum of different options a user should add to a cart item. When set to null, there is no limit
min_amount_options Int Optional. When choose_amount is enabled, this is the minimum allowed sum of the option amounts user should add to a cart item
max_amount_options Int? Optional. Nullable. When choose_amount is enabled, this is the maximum allowed sum of the option amounts a user should add to a cart item. When set to null, there is no limit

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
id Int Id of the option set
code String? Nullable. Your own ID or key that you can associate with an option set
multiple_choice Bool If true, the user can select none, one or more options (min_different_options and max_different_options is used for minimum and maximum)
choose_amount Bool If true, the user can enter an amount for every option. Note that this can only get enabled when multiple_choice = true
min_different_options Int When multiple choice is enabled, this is the minimum of different options a user should add to a cart item
max_different_options Int? Nullable. When multiple choice is enabled, this is the maximum of different options a user should add to a cart item. When set to null, there is no limit
min_amount_options Int When choose_amount is enabled, this is the minimum allowed sum of the option amounts user should add to a cart item
max_amount_options Int? Nullable. When choose_amount is enabled, this is the maximum allowed sum of the option amounts a user should add to a cart item. When set to null, there is no limit

Examples

Request

When used inside a request.

Example 1

{
    "name": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "allow_attachment": true,
    "code": "...",
    "multiple_choice": true,
    "choose_amount": false,
    "min_different_options": 16,
    "max_different_options": 18,
    "min_amount_options": 18,
    "max_amount_options": 17
}

Response

When returned in a response.

Example 1

{
    "name": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "allow_attachment": true,
    "id": 15,
    "code": "...",
    "multiple_choice": false,
    "choose_amount": false,
    "min_different_options": 18,
    "max_different_options": 18,
    "min_amount_options": 12,
    "max_amount_options": 15
}
This is a development version Do not use this version in production
1.10.0 development