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.0.1
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 5075
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 17,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 13,
"maximum": 18,
"maximum_day": 12,
"maximum_week": 18
},
"weight": {
"minimum": 13,
"maximum": 11,
"maximum_day": 16,
"maximum_week": 13,
"suggested": 17
},
"persons": {
"minimum": 19,
"maximum": 17
}
},
"id": 13,
"option_set_ids": [
10,
17,
15
],
"allergen_ids": [
10,
15,
18
],
"category_id": 15,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Expedita fugit autem eius tempora doloremque error eius aut in dolorem."
},
"description": {
"en": "Quaerat in nemo corrupti suscipit esse quos. Officia accusamus eos est eum consequuntur odio in unde. Id hic excepturi sit id."
},
"url": {
"en": "http://www.sporer.com/"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 19,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 12,
"maximum": 19,
"maximum_day": 19,
"maximum_week": 16
},
"weight": {
"minimum": 11,
"maximum": 10,
"maximum_day": 11,
"maximum_week": 18,
"suggested": 16
},
"persons": {
"minimum": 15,
"maximum": 13
}
},
"id": 18,
"option_set_ids": [
16,
19,
17
],
"allergen_ids": [
12,
14,
12
],
"category_id": 18,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Accusantium dignissimos aut doloremque nemo dolor laborum in."
},
"description": {
"en": "Id et delectus id similique. Quisquam commodi voluptatum est ea quia labore."
},
"url": {
"en": "http://www.prosacco.com/aperiam-suscipit-molestiae-ut-sunt-temporibus-sint-ut"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 19,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 12,
"maximum": 13,
"maximum_day": 18,
"maximum_week": 14
},
"weight": {
"minimum": 17,
"maximum": 13,
"maximum_day": 16,
"maximum_week": 11,
"suggested": 15
},
"persons": {
"minimum": 17,
"maximum": 18
}
},
"id": 17,
"option_set_ids": [
11,
10,
12
],
"allergen_ids": [
12,
14,
18
],
"category_id": 19,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Sit dolorum dolor perferendis ut numquam."
},
"description": {
"en": "Quo provident ipsa nihil quo. Quam laudantium cumque deserunt expedita qui suscipit consequatur. Nam eum consequatur unde doloribus ut corporis."
},
"url": {
"en": "http://www.huels.biz/aut-et-magni-illo-enim.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: 16857
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"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": 13,
"maximum": 10,
"maximum_day": 16,
"maximum_week": 14
},
"weight": {
"minimum": 19,
"maximum": 14,
"maximum_day": 15,
"maximum_week": 12,
"suggested": 18
},
"persons": {
"minimum": 18,
"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": 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
}
],
"product_prices": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 15,
"id": 18,
"order": 13,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 11,
"id": 12,
"order": 15,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 11,
"id": 10,
"order": 12,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 10
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 18
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 13
}
],
"id": 19,
"allergens": [
{
"id": 18,
"name": "Sesame"
},
{
"id": 10,
"name": "Mollusc"
},
{
"id": 18,
"name": "Fish"
}
],
"category_id": 16,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Voluptate sint dolorum odit magni et neque iusto voluptatum explicabo dicta."
},
"description": {
"en": "Eos dolorum sint voluptatem perspiciatis. Modi illum fugiat aspernatur similique quos est possimus. Itaque laudantium consequatur quam et sit accusantium. Error maxime maxime unde vel amet ut."
},
"url": {
"en": "https://nitzsche.com/neque-suscipit-quis-vel-aut.html"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 18,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 19,
"maximum": 12,
"maximum_day": 18,
"maximum_week": 16
},
"weight": {
"minimum": 17,
"maximum": 15,
"maximum_day": 12,
"maximum_week": 10,
"suggested": 12
},
"persons": {
"minimum": 11,
"maximum": 17
}
},
"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": 13,
"id": 13,
"order": 15,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 12,
"id": 11,
"order": 16,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 12,
"id": 13,
"order": 13,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 15
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 12
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 15
}
],
"id": 17,
"allergens": [
{
"id": 15,
"name": "Sesame"
},
{
"id": 18,
"name": "Sulphite"
},
{
"id": 12,
"name": "Sulphite"
}
],
"category_id": 10,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Quod omnis et dolore itaque et officia corporis velit consequuntur."
},
"description": {
"en": "Voluptatem iure nulla debitis et quia animi nesciunt optio. Velit facilis quibusdam veniam. Ut similique voluptatem asperiores ratione libero suscipit."
},
"url": {
"en": "http://cremin.info/non-quam-eos-dolores-aut-illo-et-consequatur.html"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 18,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 10,
"maximum": 18,
"maximum_day": 13,
"maximum_week": 13
},
"weight": {
"minimum": 16,
"maximum": 15,
"maximum_day": 13,
"maximum_week": 14,
"suggested": 17
},
"persons": {
"minimum": 11,
"maximum": 12
}
},
"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": 18,
"id": 13,
"order": 18,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 19,
"id": 13,
"order": 19,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 11,
"id": 18,
"order": 14,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 15
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 17
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 16
}
],
"id": 18,
"allergens": [
{
"id": 15,
"name": "Gluten"
},
{
"id": 19,
"name": "Soy"
},
{
"id": 15,
"name": "Nuts"
}
],
"category_id": 14,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Porro dolorem vel necessitatibus aperiam ea vero."
},
"description": {
"en": "Aut assumenda quis atque odio sint corrupti. Minus aut omnis dolore iusto. Repudiandae explicabo quas hic maiores maiores cum cumque."
},
"url": {
"en": "http://www.mcdermott.com/"
}
},
"code": "..."
}
]