Update multiple products

PATCH /company/products/bulk

Request

Authentication

This endpoint requires authentication.

Header Value
Authorization Set the value to Bearer + + access_token

Body

Pass the following properties via application/json or form encoding in the body of the request.

Minimum 1. Maximum 50. Array of company.Product.detailed-id: [company.Product.detailed-id]

company.Product.detailed-id

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 separate 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 separate 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

Example request 1

PATCH /company/products/bulk HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.5.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 4688
[
    {
        "name": "Cheyanne Becker Sr.",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "specialty": false,
        "active": true,
        "only_order_in_store": false,
        "price_type": "PER_UNIT",
        "price": 17,
        "target_price": false,
        "url_type": "none",
        "url": "https://example.com",
        "min_max": {
            "amount": {
                "minimum": 18,
                "maximum": 17,
                "maximum_day": 11,
                "maximum_week": 15
            },
            "weight": {
                "minimum": 19,
                "maximum": 14,
                "maximum_day": 19,
                "maximum_week": 13,
                "suggested": 12
            },
            "persons": {
                "minimum": 11,
                "maximum": 11
            }
        },
        "id": 13,
        "option_set_ids": [
            13,
            12,
            12
        ],
        "allergen_ids": [
            11,
            19,
            14
        ],
        "category_id": 13,
        "seo": {
            "title": "Nisi reiciendis debitis consequatur eligendi necessitatibus laborum labore atque.",
            "description": "Soluta eos explicabo id aut modi consectetur enim eum. Ea quos facilis magnam qui in aut delectus. Enim enim quos ut delectus culpa odit sit quisquam.",
            "url": "http://www.schowalter.info/doloremque-officiis-est-enim-in-quidem-ut-aut.html"
        },
        "price_look_up_code": "...",
        "code": "..."
    },
    {
        "name": "Henderson Ryan",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "specialty": true,
        "active": true,
        "only_order_in_store": false,
        "price_type": "PER_UNIT",
        "price": 11,
        "target_price": false,
        "url_type": "none",
        "url": "https://example.com",
        "min_max": {
            "amount": {
                "minimum": 11,
                "maximum": 18,
                "maximum_day": 16,
                "maximum_week": 19
            },
            "weight": {
                "minimum": 14,
                "maximum": 14,
                "maximum_day": 17,
                "maximum_week": 19,
                "suggested": 10
            },
            "persons": {
                "minimum": 17,
                "maximum": 13
            }
        },
        "id": 16,
        "option_set_ids": [
            15,
            15,
            15
        ],
        "allergen_ids": [
            17,
            10,
            11
        ],
        "category_id": 11,
        "seo": {
            "title": "Aut enim non et nisi reprehenderit praesentium quasi recusandae molestiae.",
            "description": "Vitae provident est aperiam quis dolor. Occaecati ea aut ut error vel. Et et omnis sed quae ipsum perferendis. Quibusdam sed aut aut aut eos. Enim doloribus quisquam culpa illo et atque est qui.",
            "url": "http://www.renner.com/aliquam-enim-expedita-aliquam-magnam"
        },
        "price_look_up_code": "...",
        "code": "..."
    },
    {
        "name": "Hanna Emard",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "specialty": true,
        "active": true,
        "only_order_in_store": false,
        "price_type": "PER_UNIT",
        "price": 14,
        "target_price": false,
        "url_type": "none",
        "url": "https://example.com",
        "min_max": {
            "amount": {
                "minimum": 19,
                "maximum": 17,
                "maximum_day": 10,
                "maximum_week": 11
            },
            "weight": {
                "minimum": 14,
                "maximum": 15,
                "maximum_day": 17,
                "maximum_week": 11,
                "suggested": 12
            },
            "persons": {
                "minimum": 16,
                "maximum": 16
            }
        },
        "id": 11,
        "option_set_ids": [
            11,
            13,
            17
        ],
        "allergen_ids": [
            15,
            16,
            13
        ],
        "category_id": 13,
        "seo": {
            "title": "Voluptatem sunt nihil officiis temporibus unde aut quod reprehenderit eveniet.",
            "description": "Deserunt nisi saepe alias amet doloremque quia expedita facilis. Voluptatem earum et modi harum.",
            "url": "http://predovic.biz/"
        },
        "price_look_up_code": "...",
        "code": "..."
    }
]

Response

Array of company.Product.detailed: [company.Product.detailed]

company.Product.detailed

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 separate 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 separate 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

Example response 1

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 16507

[
    {
        "name": "Dr. Miracle Von",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "specialty": true,
        "active": true,
        "only_order_in_store": true,
        "price_type": "PER_UNIT",
        "price": 13,
        "target_price": false,
        "url_type": "none",
        "url": "https://example.com",
        "min_max": {
            "amount": {
                "minimum": 19,
                "maximum": 16,
                "maximum_day": 15,
                "maximum_week": 10
            },
            "weight": {
                "minimum": 11,
                "maximum": 18,
                "maximum_day": 13,
                "maximum_week": 18,
                "suggested": 14
            },
            "persons": {
                "minimum": 14,
                "maximum": 16
            }
        },
        "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": false
            }
        ],
        "product_prices": [
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "price": 17,
                "id": 17,
                "order": 10,
                "price_look_up_code": "...",
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "price": 19,
                "id": 11,
                "order": 18,
                "price_look_up_code": "...",
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "price": 11,
                "id": 14,
                "order": 12,
                "price_look_up_code": "...",
                "code": "..."
            }
        ],
        "option_sets": [
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "allow_attachment": false,
                "id": 10,
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "allow_attachment": false,
                "id": 18,
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "allow_attachment": false,
                "id": 13,
                "code": "..."
            }
        ],
        "id": 16,
        "allergens": [
            {
                "id": 16,
                "name": "1320"
            },
            {
                "id": 18,
                "name": "1319"
            },
            {
                "id": 11,
                "name": "1332"
            }
        ],
        "category_id": 14,
        "price_look_up_code": "...",
        "code": "...",
        "seo": {
            "title": "Fuga nesciunt ut et vitae ad ipsum aliquid dolores ea.",
            "description": "Voluptatem voluptatem eum aliquam consectetur. Explicabo qui sed ut iusto quaerat. Iure maxime non corrupti velit officia. Quia qui quaerat esse quidem.",
            "url": "http://rempel.com/deleniti-illo-ex-quod-assumenda-et-sed-natus"
        }
    },
    {
        "name": "Samson Botsford",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "specialty": false,
        "active": true,
        "only_order_in_store": false,
        "price_type": "PER_UNIT",
        "price": 14,
        "target_price": false,
        "url_type": "none",
        "url": "https://example.com",
        "min_max": {
            "amount": {
                "minimum": 10,
                "maximum": 18,
                "maximum_day": 11,
                "maximum_week": 16
            },
            "weight": {
                "minimum": 10,
                "maximum": 14,
                "maximum_day": 10,
                "maximum_week": 14,
                "suggested": 14
            },
            "persons": {
                "minimum": 17,
                "maximum": 13
            }
        },
        "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
            }
        ],
        "product_prices": [
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "price": 16,
                "id": 14,
                "order": 16,
                "price_look_up_code": "...",
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "price": 16,
                "id": 13,
                "order": 17,
                "price_look_up_code": "...",
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "price": 15,
                "id": 16,
                "order": 13,
                "price_look_up_code": "...",
                "code": "..."
            }
        ],
        "option_sets": [
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "allow_attachment": false,
                "id": 17,
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "allow_attachment": false,
                "id": 15,
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "allow_attachment": false,
                "id": 19,
                "code": "..."
            }
        ],
        "id": 16,
        "allergens": [
            {
                "id": 15,
                "name": "1326"
            },
            {
                "id": 13,
                "name": "1333"
            },
            {
                "id": 14,
                "name": "1332"
            }
        ],
        "category_id": 17,
        "price_look_up_code": "...",
        "code": "...",
        "seo": {
            "title": "Veniam itaque ut velit neque eum at.",
            "description": "Dolores recusandae qui unde rerum distinctio debitis ad enim. Consequatur asperiores harum harum nihil ut totam soluta rem.",
            "url": "https://parker.com/non-deserunt-laborum-eum-odit-quis-enim-molestias.html"
        }
    },
    {
        "name": "Jocelyn Runte",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "specialty": true,
        "active": false,
        "only_order_in_store": true,
        "price_type": "PER_UNIT",
        "price": 12,
        "target_price": true,
        "url_type": "none",
        "url": "https://example.com",
        "min_max": {
            "amount": {
                "minimum": 17,
                "maximum": 10,
                "maximum_day": 15,
                "maximum_week": 16
            },
            "weight": {
                "minimum": 14,
                "maximum": 14,
                "maximum_day": 13,
                "maximum_week": 17,
                "suggested": 13
            },
            "persons": {
                "minimum": 16,
                "maximum": 15
            }
        },
        "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
            }
        ],
        "product_prices": [
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "price": 19,
                "id": 16,
                "order": 18,
                "price_look_up_code": "...",
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "price": 10,
                "id": 12,
                "order": 10,
                "price_look_up_code": "...",
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "price": 17,
                "id": 14,
                "order": 10,
                "price_look_up_code": "...",
                "code": "..."
            }
        ],
        "option_sets": [
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "allow_attachment": true,
                "id": 11,
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "allow_attachment": false,
                "id": 11,
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "allow_attachment": false,
                "id": 18,
                "code": "..."
            }
        ],
        "id": 15,
        "allergens": [
            {
                "id": 17,
                "name": "1323"
            },
            {
                "id": 14,
                "name": "1321"
            },
            {
                "id": 12,
                "name": "1321"
            }
        ],
        "category_id": 12,
        "price_look_up_code": "...",
        "code": "...",
        "seo": {
            "title": "Molestiae id distinctio eius dolorem minima et voluptas.",
            "description": "Quia autem culpa et ipsa exercitationem. Qui dolore sed molestiae. Explicabo ea suscipit eum. Tempore quia sint dolorem aut.",
            "url": "https://abernathy.com/veritatis-modi-iusto-dolor-voluptas.html"
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.6.0)
1.5.0 stable