Product.simple

Request

Fields when send to the api inside a request.

Field Type Description
favourite Bool A boolean value
category Dictionary Optional. A dictionary with fields
origin String Optional. Translated origin of the product

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.
only_order_in_store Bool Whether this product can only get ordered in the store with a separate UI for the shop employees, and not in the public webshop. Note that you will never receive products with this property set to true if you are not authorized.
category Dictionary Optional. A dictionary with fields
origin String Optional. Translated origin of the product

Examples

Request

When used inside a request.

Example 1

{
    "favourite": true,
    "category": {
        "id": 19,
        "name": "..."
    },
    "origin": "..."
}

Response

When returned in a response.

Example 1

{
    "id": 19,
    "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": false
        },
        {
            "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": false
        }
    ],
    "price_type": "PER_UNIT",
    "target_price": false,
    "price": {
        "value": 16,
        "currency": "EUR"
    },
    "only_order_in_store": true,
    "category": {
        "id": 19,
        "name": "..."
    },
    "origin": "..."
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.8.0 stable