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.
offer OfferItem? Nullable. Specificies where a discount should get appllied. A shop can give a complete category a discount, or only a certain product, or only a fixed product price. When calculating the discount, always round the price to 1 cent before multiplying it with an amount, persons or kilograms.

Examples

Request

When used inside a request.

Example 1

{
    "favourite": true
}

Response

When returned in a response.

Example 1

{
    "id": 12,
    "name": "string",
    "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": true,
    "price": {
        "value": 12,
        "currency": "EUR"
    },
    "subtitle": "string",
    "description": "string",
    "allergens": [
        {
            "id": 12,
            "name": "string"
        },
        {
            "id": 12,
            "name": "string"
        },
        {
            "id": 12,
            "name": "string"
        }
    ],
    "url": "https://example.com",
    "url_type": "none",
    "specialty": true,
    "favourite": true,
    "product_prices": [
        {
            "id": 12,
            "name": "string",
            "price": {
                "value": 12,
                "currency": "EUR"
            },
            "offer": {
                "type": "percentage",
                "x": 12,
                "y": 12,
                "percentage": 12,
                "minimum": 12,
                "offer": {
                    "id": 12,
                    "name": "string"
                }
            }
        },
        {
            "id": 12,
            "name": "string",
            "price": {
                "value": 12,
                "currency": "EUR"
            },
            "offer": {
                "type": "percentage",
                "x": 12,
                "y": 12,
                "percentage": 12,
                "minimum": 12,
                "offer": {
                    "id": 12,
                    "name": "string"
                }
            }
        },
        {
            "id": 12,
            "name": "string",
            "price": {
                "value": 12,
                "currency": "EUR"
            },
            "offer": {
                "type": "percentage",
                "x": 12,
                "y": 12,
                "percentage": 12,
                "minimum": 12,
                "offer": {
                    "id": 12,
                    "name": "string"
                }
            }
        }
    ],
    "optionsets": [
        {
            "id": 12,
            "name": "string",
            "code": "string",
            "options": [
                {
                    "id": 12,
                    "name": "string",
                    "price_change": {
                        "value": 12,
                        "currency": "EUR"
                    },
                    "image": {
                        "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
                    },
                    "require_image": true,
                    "code": "string"
                },
                {
                    "id": 12,
                    "name": "string",
                    "price_change": {
                        "value": 12,
                        "currency": "EUR"
                    },
                    "image": {
                        "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
                    },
                    "require_image": true,
                    "code": "string"
                },
                {
                    "id": 12,
                    "name": "string",
                    "price_change": {
                        "value": 12,
                        "currency": "EUR"
                    },
                    "image": {
                        "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
                    },
                    "require_image": true,
                    "code": "string"
                }
            ]
        },
        {
            "id": 12,
            "name": "string",
            "code": "string",
            "options": [
                {
                    "id": 12,
                    "name": "string",
                    "price_change": {
                        "value": 12,
                        "currency": "EUR"
                    },
                    "image": {
                        "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
                    },
                    "require_image": true,
                    "code": "string"
                },
                {
                    "id": 12,
                    "name": "string",
                    "price_change": {
                        "value": 12,
                        "currency": "EUR"
                    },
                    "image": {
                        "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
                    },
                    "require_image": true,
                    "code": "string"
                },
                {
                    "id": 12,
                    "name": "string",
                    "price_change": {
                        "value": 12,
                        "currency": "EUR"
                    },
                    "image": {
                        "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
                    },
                    "require_image": true,
                    "code": "string"
                }
            ]
        },
        {
            "id": 12,
            "name": "string",
            "code": "string",
            "options": [
                {
                    "id": 12,
                    "name": "string",
                    "price_change": {
                        "value": 12,
                        "currency": "EUR"
                    },
                    "image": {
                        "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
                    },
                    "require_image": true,
                    "code": "string"
                },
                {
                    "id": 12,
                    "name": "string",
                    "price_change": {
                        "value": 12,
                        "currency": "EUR"
                    },
                    "image": {
                        "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
                    },
                    "require_image": true,
                    "code": "string"
                },
                {
                    "id": 12,
                    "name": "string",
                    "price_change": {
                        "value": 12,
                        "currency": "EUR"
                    },
                    "image": {
                        "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
                    },
                    "require_image": true,
                    "code": "string"
                }
            ]
        }
    ],
    "min_max": {
        "amount": {
            "minimum": 12,
            "maximum": 12,
            "suggested": 12
        },
        "weight": {
            "minimum": 12,
            "maximum": 12,
            "suggested": 12
        },
        "persons": {
            "minimum": 12,
            "maximum": 12,
            "suggested": 12
        }
    },
    "info": [
        {
            "name": "string",
            "title": "string",
            "text": "string",
            "type": "HTML"
        },
        {
            "name": "string",
            "title": "string",
            "text": "string",
            "type": "HTML"
        },
        {
            "name": "string",
            "title": "string",
            "text": "string",
            "type": "HTML"
        }
    ],
    "offer": {
        "type": "percentage",
        "x": 12,
        "y": 12,
        "percentage": 12,
        "minimum": 12,
        "offer": {
            "id": 12,
            "name": "string"
        }
    }
}
1.5.0 stable