Create multiple products

POST /company/companies/@id/products/bulk

Request

Authentication

This endpoint requires authentication.

Header Value
Authorization Set the value to Bearer + + access_token

URL parameters

Replace the @ keywords in the URL with their corresponding value.

A dictionary with fields

Field Type Description
id Int Company ID. Create multiple products in this company

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: [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
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

POST /company/companies/11/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: 4626
[
    {
        "name": "Mavis Gerlach",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "specialty": false,
        "active": false,
        "only_order_in_store": false,
        "price_type": "PER_UNIT",
        "price": 16,
        "target_price": false,
        "url_type": "none",
        "url": "https://example.com",
        "min_max": {
            "amount": {
                "minimum": 18,
                "maximum": 15,
                "maximum_day": 18,
                "maximum_week": 18
            },
            "weight": {
                "minimum": 19,
                "maximum": 13,
                "maximum_day": 19,
                "maximum_week": 15,
                "suggested": 11
            },
            "persons": {
                "minimum": 15,
                "maximum": 11
            }
        },
        "option_set_ids": [
            14,
            15,
            19
        ],
        "allergen_ids": [
            12,
            14,
            13
        ],
        "category_id": 12,
        "seo": {
            "title": "Voluptatem iusto est dolorem dolor sequi ipsa.",
            "description": "Ipsa sed sed in fugiat. Est aut praesentium quas. Eveniet qui consequuntur atque et. Eum molestias dolores eos omnis iure asperiores quo.",
            "url": "http://www.watsica.com/harum-deserunt-officiis-hic-nobis.html"
        },
        "price_look_up_code": "...",
        "code": "..."
    },
    {
        "name": "Tremaine Botsford IV",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "specialty": false,
        "active": false,
        "only_order_in_store": false,
        "price_type": "PER_UNIT",
        "price": 13,
        "target_price": true,
        "url_type": "none",
        "url": "https://example.com",
        "min_max": {
            "amount": {
                "minimum": 10,
                "maximum": 19,
                "maximum_day": 10,
                "maximum_week": 15
            },
            "weight": {
                "minimum": 16,
                "maximum": 15,
                "maximum_day": 18,
                "maximum_week": 16,
                "suggested": 11
            },
            "persons": {
                "minimum": 15,
                "maximum": 11
            }
        },
        "option_set_ids": [
            17,
            12,
            14
        ],
        "allergen_ids": [
            17,
            18,
            10
        ],
        "category_id": 14,
        "seo": {
            "title": "Error rerum minus occaecati assumenda vel quisquam recusandae aut.",
            "description": "Perspiciatis assumenda recusandae labore harum et deleniti. Suscipit nihil voluptatem quae quaerat facere. Ullam ut et repudiandae sunt est. Incidunt qui quia mollitia quia adipisci voluptatem eum.",
            "url": "http://beier.com/sit-voluptas-quis-dolor-cupiditate-rerum-voluptatem"
        },
        "price_look_up_code": "...",
        "code": "..."
    },
    {
        "name": "Susie Beatty II",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "specialty": true,
        "active": false,
        "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": 17,
                "maximum": 14,
                "maximum_day": 14,
                "maximum_week": 11
            },
            "weight": {
                "minimum": 15,
                "maximum": 13,
                "maximum_day": 16,
                "maximum_week": 11,
                "suggested": 12
            },
            "persons": {
                "minimum": 11,
                "maximum": 10
            }
        },
        "option_set_ids": [
            17,
            14,
            14
        ],
        "allergen_ids": [
            19,
            14,
            16
        ],
        "category_id": 19,
        "seo": {
            "title": "Quia architecto dicta ut velit iusto.",
            "description": "Aperiam et asperiores autem mollitia sapiente. Doloremque similique rerum quia et nihil. Reiciendis sunt sint occaecati et excepturi ea aliquid et. Voluptate libero ducimus id qui.",
            "url": "http://wilkinson.com/"
        },
        "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: 16658

[
    {
        "name": "John Harber",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "specialty": true,
        "active": true,
        "only_order_in_store": false,
        "price_type": "PER_UNIT",
        "price": 15,
        "target_price": false,
        "url_type": "none",
        "url": "https://example.com",
        "min_max": {
            "amount": {
                "minimum": 12,
                "maximum": 19,
                "maximum_day": 15,
                "maximum_week": 16
            },
            "weight": {
                "minimum": 17,
                "maximum": 13,
                "maximum_day": 14,
                "maximum_week": 14,
                "suggested": 12
            },
            "persons": {
                "minimum": 18,
                "maximum": 18
            }
        },
        "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": 13,
                "id": 18,
                "order": 10,
                "price_look_up_code": "...",
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "price": 13,
                "id": 15,
                "order": 11,
                "price_look_up_code": "...",
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "price": 18,
                "id": 16,
                "order": 19,
                "price_look_up_code": "...",
                "code": "..."
            }
        ],
        "option_sets": [
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "allow_attachment": false,
                "id": 19,
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "allow_attachment": true,
                "id": 17,
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "allow_attachment": true,
                "id": 17,
                "code": "..."
            }
        ],
        "id": 16,
        "allergens": [
            {
                "id": 18,
                "name": "1320"
            },
            {
                "id": 16,
                "name": "1332"
            },
            {
                "id": 10,
                "name": "1333"
            }
        ],
        "category_id": 12,
        "price_look_up_code": "...",
        "code": "...",
        "seo": {
            "title": "Similique nostrum blanditiis tempore et ut voluptatem eaque quo.",
            "description": "Officia est aliquid pariatur culpa. Pariatur est ipsum voluptas repudiandae culpa. Deleniti consequatur ut amet voluptas. Dolor omnis itaque eveniet velit cupiditate minus dolor.",
            "url": "http://mcclure.org/expedita-voluptas-nemo-accusantium-et"
        }
    },
    {
        "name": "Ms. Helen Padberg",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "specialty": false,
        "active": false,
        "only_order_in_store": false,
        "price_type": "PER_UNIT",
        "price": 18,
        "target_price": true,
        "url_type": "none",
        "url": "https://example.com",
        "min_max": {
            "amount": {
                "minimum": 12,
                "maximum": 11,
                "maximum_day": 14,
                "maximum_week": 18
            },
            "weight": {
                "minimum": 18,
                "maximum": 10,
                "maximum_day": 13,
                "maximum_week": 10,
                "suggested": 16
            },
            "persons": {
                "minimum": 19,
                "maximum": 10
            }
        },
        "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": 15,
                "id": 14,
                "order": 12,
                "price_look_up_code": "...",
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "price": 11,
                "id": 17,
                "order": 17,
                "price_look_up_code": "...",
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "price": 15,
                "id": 12,
                "order": 10,
                "price_look_up_code": "...",
                "code": "..."
            }
        ],
        "option_sets": [
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "allow_attachment": true,
                "id": 18,
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "allow_attachment": false,
                "id": 16,
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "allow_attachment": true,
                "id": 19,
                "code": "..."
            }
        ],
        "id": 13,
        "allergens": [
            {
                "id": 17,
                "name": "1325"
            },
            {
                "id": 14,
                "name": "1327"
            },
            {
                "id": 13,
                "name": "1323"
            }
        ],
        "category_id": 12,
        "price_look_up_code": "...",
        "code": "...",
        "seo": {
            "title": "Omnis est animi animi officia dolorem quo aut quaerat numquam soluta.",
            "description": "Non numquam iste assumenda vitae eum. Laboriosam sit autem vitae ut et deleniti ut. Nisi adipisci rem in consequatur dignissimos animi omnis.",
            "url": "http://wiza.com/delectus-nihil-autem-rerum-dolor.html"
        }
    },
    {
        "name": "Branson Bernhard",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "specialty": false,
        "active": true,
        "only_order_in_store": false,
        "price_type": "PER_UNIT",
        "price": 15,
        "target_price": true,
        "url_type": "none",
        "url": "https://example.com",
        "min_max": {
            "amount": {
                "minimum": 14,
                "maximum": 17,
                "maximum_day": 15,
                "maximum_week": 17
            },
            "weight": {
                "minimum": 18,
                "maximum": 10,
                "maximum_day": 16,
                "maximum_week": 10,
                "suggested": 12
            },
            "persons": {
                "minimum": 11,
                "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": 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
            },
            {
                "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": 14,
                "id": 19,
                "order": 13,
                "price_look_up_code": "...",
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "price": 13,
                "id": 19,
                "order": 17,
                "price_look_up_code": "...",
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "price": 16,
                "id": 18,
                "order": 19,
                "price_look_up_code": "...",
                "code": "..."
            }
        ],
        "option_sets": [
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "allow_attachment": true,
                "id": 19,
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "allow_attachment": true,
                "id": 10,
                "code": "..."
            },
            {
                "name": {
                    "nl": "...",
                    "en": "...",
                    "fr": "..."
                },
                "allow_attachment": false,
                "id": 15,
                "code": "..."
            }
        ],
        "id": 11,
        "allergens": [
            {
                "id": 18,
                "name": "1320"
            },
            {
                "id": 14,
                "name": "1325"
            },
            {
                "id": 16,
                "name": "1322"
            }
        ],
        "category_id": 17,
        "price_look_up_code": "...",
        "code": "...",
        "seo": {
            "title": "Qui officiis molestias qui qui laudantium officiis voluptates molestiae facere commodi.",
            "description": "Tempora rerum at eum at. Odit vero temporibus voluptas ratione. Eum qui dolore ipsam molestiae. Quas harum modi omnis labore. Perferendis maxime rerum corrupti eum.",
            "url": "https://www.schaefer.com/sed-distinctio-recusandae-consequatur-cumque-aspernatur"
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.6.0)
1.5.0 stable