company.Product.detailed-id

Request

Fields when send to the api inside a request.

Field Type Description
name [Language: String] Name of the product
description [Language: String] Description of the product
specialty Bool Whether this product is a specialty. Specialties are also displayed in a seperate category and are highlighted with a star icon.
active Bool Inactive products are not visible in the webshop
only_order_in_store Bool Whether this product can only get ordered in the store with a seperate UI for the shop employees, and not in the public webshop.
price_type PriceType A product has a price type that defines the price calculations and the way consumers can order the product.
price UInt Price of the product (cents). Please note that this value is ignored when price_type is MULTIPLE_CHOICE.
target_price Bool Is true when it's not possible to provide an exact price of this product when ordering (e.g. not exact weight possible). This option might deactive online payments for orders with this product (shop settings).
url_type String String enumarion of 'none', 'recipe', 'website'
url URL? Nullable. An URL field starting with http:// or https://
min_max company.MinMaxSummary The allowed amounts a customer is allowed to order of a product for amount / weight / persons
id Int ID of the product you want to update
option_set_ids [Int] ID's of the option sets you want to assign to this product. You can alter the order by switching the position of the ID's
allergen_ids [Int]? Nullable. ID's of the allergens of this product. Set to null if you don't want to specify allergens. Only use an empty array when the product has no allergens. It is a subtle difference but it has legal consequences if you set this to the wrong value. You can find all the available allergen ID's here.
category_id Int The category ID of the product
seo company.SeoData Optional. Product page SEO metatags
price_look_up_code String? Optional. Nullable. A String value
code String? Optional. Nullable. A custom code. You can set this to your own code and use this field to map your products to Bakeronline products

Response

Fields when returned by the api in a response.

Field Type Description
name [Language: String] Name of the product
description [Language: String] Description of the product
specialty Bool Whether this product is a specialty. Specialties are also displayed in a seperate category and are highlighted with a star icon.
active Bool Inactive products are not visible in the webshop
only_order_in_store Bool Whether this product can only get ordered in the store with a seperate UI for the shop employees, and not in the public webshop.
price_type PriceType A product has a price type that defines the price calculations and the way consumers can order the product.
price UInt Price of the product (cents). Please note that this value is ignored when price_type is MULTIPLE_CHOICE.
target_price Bool Is true when it's not possible to provide an exact price of this product when ordering (e.g. not exact weight possible). This option might deactive online payments for orders with this product (shop settings).
url_type String String enumarion of 'none', 'recipe', 'website'
url URL? Nullable. An URL field starting with http:// or https://
min_max company.MinMaxSummary The allowed amounts a customer is allowed to order of a product for amount / weight / persons
images [Image] Array of Image
product_prices [company.ProductPrice] Array of company.ProductPrice
option_sets [company.OptionSet.simple] Array of company.OptionSet.simple
id Int Id of the product
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).
category_id Int The category ID of the product
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
seo company.SeoData Optional. Product page SEO metatags

Examples

Request

When used inside a request.

Example 1

{
    "id": 724,
    "name": {
        "nl": "Croissant"
    },
    "description": {
        "nl": ""
    },
    "specialty": false,
    "active": true,
    "only_order_in_store": false,
    "allergens": [
        {
            "id": 12,
            "name": "1330"
        }
    ],
    "price_look_up_code": "180491",
    "price_type": "MULTIPLE_CHOICE",
    "price": 937,
    "target_price": false,
    "url_type": "website",
    "url": "http://verbeke.com/aut-et-soluta-odit-facilis.html",
    "min_max": {
        "amount": {
            "minimum": 0,
            "maximum": null,
            "maximum_day": null,
            "maximum_week": null
        },
        "weight": {
            "minimum": 0,
            "maximum": null,
            "maximum_day": null,
            "maximum_week": null,
            "suggested": null
        },
        "persons": {
            "minimum": 0,
            "maximum": null
        }
    },
    "seo": {
        "title": [],
        "description": [],
        "url": []
    },
    "code": null,
    "category_id": 395,
    "images": [
        {
            "resolutions": [
                {
                    "src": "https://bakeronline.be/uploads/tests/250x200/product-wit-pannen.jpg",
                    "width": 300,
                    "height": 200
                },
                {
                    "src": "https://bakeronline.be/uploads/tests/1080x720/product-wit-pannen.jpg",
                    "width": 1080,
                    "height": 720
                }
            ],
            "white_background": true
        }
    ],
    "product_prices": [
        {
            "id": 466,
            "name": {
                "nl": "4 persons"
            },
            "price": 9,
            "order": 1,
            "price_look_up_code": "5235",
            "code": "1084"
        },
        {
            "id": 467,
            "name": {
                "nl": "3 persons"
            },
            "price": 79,
            "order": 2,
            "price_look_up_code": "927",
            "code": "8377"
        },
        {
            "id": 468,
            "name": {
                "nl": "6 persons"
            },
            "price": 54,
            "order": 3,
            "price_look_up_code": "480",
            "code": "6420"
        }
    ],
    "option_sets": []
}

Example 2

{
    "id": 725,
    "name": {
        "nl": "Piccolo"
    },
    "description": {
        "nl": "Random product description"
    },
    "specialty": false,
    "active": true,
    "only_order_in_store": false,
    "allergens": null,
    "price_look_up_code": "14772",
    "price_type": "MULTIPLE_CHOICE",
    "price": 330,
    "target_price": false,
    "url_type": "none",
    "url": "https://delhaye.com/qui-occaecati-nulla-aperiam.html",
    "min_max": {
        "amount": {
            "minimum": 0,
            "maximum": null,
            "maximum_day": null,
            "maximum_week": null
        },
        "weight": {
            "minimum": 0,
            "maximum": null,
            "maximum_day": null,
            "maximum_week": null,
            "suggested": null
        },
        "persons": {
            "minimum": 0,
            "maximum": null
        }
    },
    "seo": {
        "title": [],
        "description": [],
        "url": []
    },
    "code": "792230",
    "category_id": 395,
    "images": [
        {
            "resolutions": [
                {
                    "src": "https://bakeronline.be/uploads/tests/250x200/product-creme-bloemsuiker.jpg",
                    "width": 300,
                    "height": 200
                },
                {
                    "src": "https://bakeronline.be/uploads/tests/1080x720/product-creme-bloemsuiker.jpg",
                    "width": 1080,
                    "height": 720
                }
            ],
            "white_background": true
        }
    ],
    "product_prices": [
        {
            "id": 469,
            "name": {
                "nl": "5 persons"
            },
            "price": 3,
            "order": 1,
            "price_look_up_code": "6255",
            "code": "2974"
        },
        {
            "id": 470,
            "name": {
                "nl": "6 persons"
            },
            "price": 30,
            "order": 2,
            "price_look_up_code": "3151",
            "code": "4921"
        }
    ],
    "option_sets": [
        {
            "id": 834,
            "name": {
                "nl": "Please select an option"
            },
            "allow_attachment": false,
            "code": null
        },
        {
            "id": 835,
            "name": {
                "nl": "Do you want your bread sliced?"
            },
            "allow_attachment": false,
            "code": null
        },
        {
            "id": 836,
            "name": {
                "nl": "Do you want a bag?"
            },
            "allow_attachment": false,
            "code": null
        },
        {
            "id": 837,
            "name": {
                "nl": "Do you want your bread sliced?"
            },
            "allow_attachment": false,
            "code": null
        }
    ]
}

Response

When returned in a response.

Example 1

{
    "id": 726,
    "name": {
        "nl": "Blokjes"
    },
    "description": {
        "nl": ""
    },
    "specialty": false,
    "active": true,
    "only_order_in_store": false,
    "allergens": [
        {
            "id": 1,
            "name": "1319"
        },
        {
            "id": 2,
            "name": "1320"
        },
        {
            "id": 3,
            "name": "1321"
        },
        {
            "id": 6,
            "name": "1324"
        },
        {
            "id": 7,
            "name": "1325"
        },
        {
            "id": 8,
            "name": "1326"
        },
        {
            "id": 10,
            "name": "1328"
        },
        {
            "id": 11,
            "name": "1329"
        },
        {
            "id": 12,
            "name": "1330"
        },
        {
            "id": 13,
            "name": "1331"
        },
        {
            "id": 14,
            "name": "1332"
        },
        {
            "id": 15,
            "name": "1333"
        }
    ],
    "price_look_up_code": null,
    "price_type": "PER_UNIT",
    "price": 373,
    "target_price": false,
    "url_type": "none",
    "url": "http://www.desmedt.com/odit-omnis-est-voluptate-rerum-porro-et",
    "min_max": {
        "amount": {
            "minimum": 0,
            "maximum": null,
            "maximum_day": null,
            "maximum_week": null
        },
        "weight": {
            "minimum": 0,
            "maximum": null,
            "maximum_day": null,
            "maximum_week": null,
            "suggested": null
        },
        "persons": {
            "minimum": 0,
            "maximum": null
        }
    },
    "seo": {
        "title": [],
        "description": [],
        "url": []
    },
    "code": null,
    "category_id": 396,
    "images": [
        {
            "resolutions": [
                {
                    "src": "https://bakeronline.be/uploads/tests/250x200/product-wit-pannen.jpg",
                    "width": 300,
                    "height": 200
                },
                {
                    "src": "https://bakeronline.be/uploads/tests/1080x720/product-wit-pannen.jpg",
                    "width": 1080,
                    "height": 720
                }
            ],
            "white_background": true
        }
    ],
    "product_prices": [],
    "option_sets": [
        {
            "id": 838,
            "name": {
                "nl": "Do you want your bread sliced?"
            },
            "allow_attachment": false,
            "code": null
        }
    ]
}

Example 2

{
    "id": 727,
    "name": {
        "nl": "Wit stokbrood"
    },
    "description": {
        "nl": "Random product description"
    },
    "specialty": false,
    "active": true,
    "only_order_in_store": false,
    "allergens": [
        {
            "id": 6,
            "name": "1324"
        },
        {
            "id": 9,
            "name": "1327"
        },
        {
            "id": 15,
            "name": "1333"
        }
    ],
    "price_look_up_code": null,
    "price_type": "MULTIPLE_CHOICE",
    "price": 4574,
    "target_price": false,
    "url_type": "recipe",
    "url": "http://wouters.net/vero-quia-ea-consequatur-aut-explicabo-et-quia-magnam.html",
    "min_max": {
        "amount": {
            "minimum": 0,
            "maximum": null,
            "maximum_day": null,
            "maximum_week": null
        },
        "weight": {
            "minimum": 0,
            "maximum": null,
            "maximum_day": null,
            "maximum_week": null,
            "suggested": null
        },
        "persons": {
            "minimum": 0,
            "maximum": null
        }
    },
    "seo": {
        "title": [],
        "description": [],
        "url": []
    },
    "code": "326545",
    "category_id": 396,
    "images": [
        {
            "resolutions": [
                {
                    "src": "https://bakeronline.be/uploads/tests/250x200/product-wit-pannen.jpg",
                    "width": 300,
                    "height": 200
                },
                {
                    "src": "https://bakeronline.be/uploads/tests/1080x720/product-wit-pannen.jpg",
                    "width": 1080,
                    "height": 720
                }
            ],
            "white_background": true
        }
    ],
    "product_prices": [
        {
            "id": 471,
            "name": {
                "nl": "2 persons"
            },
            "price": 63,
            "order": 1,
            "price_look_up_code": "3289",
            "code": "7701"
        },
        {
            "id": 472,
            "name": {
                "nl": "2 persons"
            },
            "price": 46,
            "order": 2,
            "price_look_up_code": "6209",
            "code": "1430"
        },
        {
            "id": 473,
            "name": {
                "nl": "5 persons"
            },
            "price": 70,
            "order": 3,
            "price_look_up_code": "4723",
            "code": "2374"
        },
        {
            "id": 474,
            "name": {
                "nl": "2 persons"
            },
            "price": 91,
            "order": 4,
            "price_look_up_code": "739",
            "code": "3386"
        }
    ],
    "option_sets": [
        {
            "id": 839,
            "name": {
                "nl": "Do you want a picture on your cake?"
            },
            "allow_attachment": false,
            "code": null
        },
        {
            "id": 840,
            "name": {
                "nl": "Please select an option"
            },
            "allow_attachment": false,
            "code": null
        },
        {
            "id": 841,
            "name": {
                "nl": "Extra baked?"
            },
            "allow_attachment": false,
            "code": null
        },
        {
            "id": 842,
            "name": {
                "nl": "Do you want your bread sliced?"
            },
            "allow_attachment": false,
            "code": null
        }
    ]
}
1.5.0 stable