PATCH /company/products/bulk
This endpoint requires authentication.
| Header | Value |
|---|---|
| Authorization | Set the value to Bearer + + access_token |
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]
| 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 |
| price_look_up_code | String? | Nullable. A String value |
| seo | company.SeoData | Optional. Product page SEO metatags |
| 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 |
PATCH /company/products/bulk HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.1.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 5194
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 12,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 17,
"maximum": 10,
"maximum_day": 17,
"maximum_week": 19
},
"weight": {
"minimum": 15,
"maximum": 13,
"maximum_day": 15,
"maximum_week": 13,
"suggested": 14
},
"persons": {
"minimum": 10,
"maximum": 14
}
},
"id": 13,
"option_set_ids": [
10,
18,
10
],
"allergen_ids": [
12,
19,
12
],
"category_id": 19,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Voluptatum et tempore est nulla saepe omnis vel quaerat."
},
"description": {
"en": "Alias quis aut id ipsum velit ut tenetur sapiente. Officiis vitae minima nihil sed. Doloremque hic sunt at. Ipsum laborum repellat quis voluptas."
},
"url": {
"en": "https://www.zulauf.biz/laboriosam-beatae-sunt-molestiae-doloribus-temporibus-natus-autem"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 18,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 15,
"maximum": 11,
"maximum_day": 18,
"maximum_week": 12
},
"weight": {
"minimum": 18,
"maximum": 11,
"maximum_day": 19,
"maximum_week": 17,
"suggested": 11
},
"persons": {
"minimum": 13,
"maximum": 14
}
},
"id": 13,
"option_set_ids": [
12,
10,
15
],
"allergen_ids": [
12,
18,
13
],
"category_id": 15,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Molestiae et ut praesentium aut laborum omnis soluta quisquam quia."
},
"description": {
"en": "Quas dolorem doloremque et consequatur corporis. Molestias culpa dignissimos voluptatem impedit magni quidem quidem fugiat. Commodi qui incidunt est aperiam ea."
},
"url": {
"en": "http://www.corwin.com/eius-et-nesciunt-ut"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"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": 17,
"maximum_day": 15,
"maximum_week": 19
},
"weight": {
"minimum": 19,
"maximum": 15,
"maximum_day": 11,
"maximum_week": 11,
"suggested": 13
},
"persons": {
"minimum": 15,
"maximum": 12
}
},
"id": 10,
"option_set_ids": [
11,
13,
19
],
"allergen_ids": [
13,
16,
18
],
"category_id": 17,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Laudantium aut accusantium hic quaerat voluptas."
},
"description": {
"en": "Quia nihil tempore et voluptas et. Commodi neque dignissimos quis dolorem maxime minima. Molestias sint rerum asperiores quo."
},
"url": {
"en": "http://kunze.com/quae-impedit-ad-voluptas-in-omnis.html"
}
},
"code": "..."
}
]Array of 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 |
| seo | company.SeoData | Optional. Product page SEO metatags |
| 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 |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 16825
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 13,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 19,
"maximum": 12,
"maximum_day": 16,
"maximum_week": 18
},
"weight": {
"minimum": 14,
"maximum": 11,
"maximum_day": 17,
"maximum_week": 14,
"suggested": 15
},
"persons": {
"minimum": 19,
"maximum": 19
}
},
"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": 10,
"order": 13,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 10,
"id": 12,
"order": 19,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 17,
"id": 19,
"order": 12,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 17
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 14
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 11
}
],
"id": 11,
"allergens": [
{
"id": 15,
"name": "Fish"
},
{
"id": 11,
"name": "Nuts"
},
{
"id": 12,
"name": "Peanut"
}
],
"category_id": 13,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Qui consequatur cum mollitia eos maxime velit quia non iste."
},
"description": {
"en": "Ut ex harum est hic vero fuga. Molestiae numquam iure voluptas aut ab consequatur sit. Perferendis assumenda est velit nulla eaque ea."
},
"url": {
"en": "https://www.labadie.net/est-rerum-eligendi-esse-corporis-suscipit-qui-laborum"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"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": 14,
"maximum": 15,
"maximum_day": 10,
"maximum_week": 13
},
"weight": {
"minimum": 10,
"maximum": 15,
"maximum_day": 12,
"maximum_week": 18,
"suggested": 14
},
"persons": {
"minimum": 14,
"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": 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": 16,
"id": 13,
"order": 11,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 17,
"id": 18,
"order": 19,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 10,
"id": 14,
"order": 13,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 16
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 10
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 14
}
],
"id": 10,
"allergens": [
{
"id": 11,
"name": "Soy"
},
{
"id": 11,
"name": "Fish"
},
{
"id": 15,
"name": "Sulphite"
}
],
"category_id": 17,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Nihil culpa adipisci optio in pariatur sunt et sit sunt fugiat."
},
"description": {
"en": "Blanditiis sit deleniti assumenda quo et cum. Qui tenetur alias corporis dolorem voluptas nam debitis. Voluptas voluptas magni accusamus minus impedit."
},
"url": {
"en": "http://www.botsford.com/"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 15,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 18,
"maximum": 12,
"maximum_day": 10,
"maximum_week": 10
},
"weight": {
"minimum": 13,
"maximum": 16,
"maximum_day": 14,
"maximum_week": 10,
"suggested": 13
},
"persons": {
"minimum": 16,
"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": 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": 15,
"id": 16,
"order": 18,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 17,
"id": 16,
"order": 12,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 19,
"id": 12,
"order": 19,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 12
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 16
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 12
}
],
"id": 10,
"allergens": [
{
"id": 13,
"name": "Fish"
},
{
"id": 13,
"name": "Gluten"
},
{
"id": 13,
"name": "Lactose"
}
],
"category_id": 17,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Eos voluptas non ex quaerat."
},
"description": {
"en": "Et qui praesentium qui expedita. Voluptatem est et asperiores aut qui ut eos. Reiciendis asperiores odio reiciendis et architecto nesciunt autem excepturi. Culpa odit qui sunt culpa at enim."
},
"url": {
"en": "http://sporer.com/et-eveniet-beatae-ullam-similique-et"
}
},
"code": "..."
}
]