Product.company-order

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

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.
price_look_up_code String? Nullable. A String value
code String? Nullable. A custom code. You can set this to your own code and use this field to map your products to Bakeronline products
category Dictionary Optional. A dictionary with fields

Examples

Request

When used inside a request.

Example 1

{
    "favourite": true,
    "category": {
        "id": 17,
        "name": "..."
    }
}

Response

When returned in a response.

Example 1

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