Product.detailed

Request

Fields when send to the api inside a request.

Field Type Description
favourite Bool A boolean value

Response

Fields when returned by the api in a response.

Field Type Description
id Int Id of the product
name String Name of the product (translated)
images [Image] Array of Image
price_type PriceType A product has a price type that defines the price calculations and the way consumers can order the product.
target_price Bool Is true when the price of the product can change on takeout (e.g. not exact weight)
price Price Price of the product (cents). It only makes sense to use this property when price_type is not multiple choice. Please also check if the shop where you want to order has an offer with a discount for this product available.
subtitle String? Nullable. Important text you need to display under the product name
description String Description of the product (translated)
allergens [Allergen]? Nullable. The allergens of this product. An empty array means no allergens. Null means no allergens specified (= can have allergens, ask in shop)
url URL? Nullable. An URL field starting with http:// or https://
url_type String String enumarion of 'none', 'recipe', 'website'
specialty Bool A boolean value
favourite Bool? Nullable. A boolean value
product_prices [ProductPrice.detailed] Array of ProductPrice.detailed
optionsets [OptionSet.detailed] Array of OptionSet.detailed
min_max MinMaxSummary An overview of the minimum and maximum values for all amount types.
info [Message] A list of messages with information you need to display on the product page.

Examples

Request

When used inside a request.

Example 1

{
    "favourite": false
}

Response

When returned in a response.

Example 1

{
    "id": 16,
    "name": "...",
    "images": [
        {
            "resolutions": [
                {
                    "src": "https://example.com",
                    "width": 600,
                    "height": 350
                },
                {
                    "src": "https://example.com",
                    "width": 600,
                    "height": 350
                },
                {
                    "src": "https://example.com",
                    "width": 600,
                    "height": 350
                }
            ],
            "white_background": true
        },
        {
            "resolutions": [
                {
                    "src": "https://example.com",
                    "width": 600,
                    "height": 350
                },
                {
                    "src": "https://example.com",
                    "width": 600,
                    "height": 350
                },
                {
                    "src": "https://example.com",
                    "width": 600,
                    "height": 350
                }
            ],
            "white_background": true
        },
        {
            "resolutions": [
                {
                    "src": "https://example.com",
                    "width": 600,
                    "height": 350
                },
                {
                    "src": "https://example.com",
                    "width": 600,
                    "height": 350
                },
                {
                    "src": "https://example.com",
                    "width": 600,
                    "height": 350
                }
            ],
            "white_background": true
        }
    ],
    "price_type": "PER_UNIT",
    "target_price": false,
    "price": {
        "value": 13,
        "currency": "EUR"
    },
    "subtitle": "...",
    "description": "...",
    "allergens": [
        {
            "id": 11,
            "name": "Peanut"
        },
        {
            "id": 15,
            "name": "Milk"
        },
        {
            "id": 15,
            "name": "Nuts"
        }
    ],
    "url": "https://example.com",
    "url_type": "none",
    "specialty": false,
    "favourite": true,
    "product_prices": [
        {
            "id": 13,
            "name": "...",
            "price": {
                "value": 19,
                "currency": "EUR"
            }
        },
        {
            "id": 11,
            "name": "...",
            "price": {
                "value": 17,
                "currency": "EUR"
            }
        },
        {
            "id": 15,
            "name": "...",
            "price": {
                "value": 19,
                "currency": "EUR"
            }
        }
    ],
    "optionsets": [
        {
            "id": 18,
            "name": "...",
            "allow_attachment": false,
            "options": [
                {
                    "id": 11,
                    "name": "...",
                    "price_change": {
                        "value": 17,
                        "currency": "EUR"
                    }
                },
                {
                    "id": 13,
                    "name": "...",
                    "price_change": {
                        "value": 18,
                        "currency": "EUR"
                    }
                },
                {
                    "id": 10,
                    "name": "...",
                    "price_change": {
                        "value": 18,
                        "currency": "EUR"
                    }
                }
            ]
        },
        {
            "id": 18,
            "name": "...",
            "allow_attachment": false,
            "options": [
                {
                    "id": 11,
                    "name": "...",
                    "price_change": {
                        "value": 13,
                        "currency": "EUR"
                    }
                },
                {
                    "id": 12,
                    "name": "...",
                    "price_change": {
                        "value": 13,
                        "currency": "EUR"
                    }
                },
                {
                    "id": 12,
                    "name": "...",
                    "price_change": {
                        "value": 19,
                        "currency": "EUR"
                    }
                }
            ]
        },
        {
            "id": 13,
            "name": "...",
            "allow_attachment": false,
            "options": [
                {
                    "id": 13,
                    "name": "...",
                    "price_change": {
                        "value": 18,
                        "currency": "EUR"
                    }
                },
                {
                    "id": 11,
                    "name": "...",
                    "price_change": {
                        "value": 11,
                        "currency": "EUR"
                    }
                },
                {
                    "id": 12,
                    "name": "...",
                    "price_change": {
                        "value": 19,
                        "currency": "EUR"
                    }
                }
            ]
        }
    ],
    "min_max": {
        "amount": {
            "minimum": 12,
            "maximum": 13,
            "suggested": 17
        },
        "weight": {
            "minimum": 10,
            "maximum": 11,
            "suggested": 17
        },
        "persons": {
            "minimum": 16,
            "maximum": 16,
            "suggested": 11
        }
    },
    "info": [
        {
            "name": "...",
            "title": "...",
            "text": "...",
            "type": "HTML"
        },
        {
            "name": "...",
            "title": "...",
            "text": "...",
            "type": "HTML"
        },
        {
            "name": "...",
            "title": "...",
            "text": "...",
            "type": "HTML"
        }
    ]
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.3.0 stable