company.Option

Request

Fields when send to the api inside a request.

Field Type Description
name [Language: String] Name of the option
price_change Int Price change in cents. Positive for price increase, negative for discounts.
order Int The options of a option set are sorted on the order property (descending). If you specify the same order for multiple option sets, the id of the option set is used. Setting the same order for all option sets is discouraged.
code String? Optional. Nullable. Your own ID or key that you can associate with an option

Response

Fields when returned by the api in a response.

Field Type Description
name [Language: String] Name of the option
price_change Int Price change in cents. Positive for price increase, negative for discounts.
id Int ID of this option
code String? Nullable. Your own ID or key that you can associate with an option
order Int The options of a option set are sorted on the order property (descending). If you specify the same order for multiple option sets, the id of the option set is used. Setting the same order for all option sets is discouraged.

Examples

Request

When used inside a request.

Example 1

{
    "id": 2726,
    "name": {
        "nl": "Yes please"
    },
    "price_change": 169,
    "code": null,
    "order": 1
}

Example 2

{
    "id": 2727,
    "name": {
        "nl": "Yes"
    },
    "price_change": -579,
    "code": null,
    "order": 2
}

Response

When returned in a response.

Example 1

{
    "id": 2728,
    "name": {
        "nl": "No thank you"
    },
    "price_change": -621,
    "code": null,
    "order": 1
}

Example 2

{
    "id": 2729,
    "name": {
        "nl": "Yes please"
    },
    "price_change": 29,
    "code": null,
    "order": 2
}
1.5.0 stable