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 |
| 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 |
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: 5116
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 13,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 17,
"maximum": 18,
"maximum_day": 17,
"maximum_week": 12
},
"weight": {
"minimum": 15,
"maximum": 15,
"maximum_day": 10,
"maximum_week": 12,
"suggested": 11
},
"persons": {
"minimum": 18,
"maximum": 13
}
},
"id": 13,
"option_set_ids": [
18,
13,
11
],
"allergen_ids": [
18,
19,
15
],
"category_id": 10,
"seo": {
"title": {
"en": "Unde quis quo qui repellendus et eum."
},
"description": {
"en": "Dolor quis sunt magnam nulla id doloremque in. Hic nisi ut reiciendis. Perferendis impedit dolor dolor accusantium quia. Qui pariatur fuga aut iste ipsum natus in."
},
"url": {
"en": "http://www.osinski.net/quidem-et-voluptates-deleniti-aspernatur-explicabo-animi-quam-ut"
}
},
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"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": 19,
"maximum": 15,
"maximum_day": 12,
"maximum_week": 11
},
"weight": {
"minimum": 12,
"maximum": 16,
"maximum_day": 19,
"maximum_week": 11,
"suggested": 11
},
"persons": {
"minimum": 14,
"maximum": 19
}
},
"id": 17,
"option_set_ids": [
12,
12,
17
],
"allergen_ids": [
17,
18,
13
],
"category_id": 10,
"seo": {
"title": {
"en": "Atque cum eum ab similique asperiores a qui error et labore."
},
"description": {
"en": "Minus ut cupiditate repellat quia. Dolorem et sapiente quas dicta sint vel. Qui excepturi reprehenderit voluptatem possimus."
},
"url": {
"en": "http://roob.com/"
}
},
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"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": 11,
"maximum": 17,
"maximum_day": 10,
"maximum_week": 14
},
"weight": {
"minimum": 19,
"maximum": 17,
"maximum_day": 11,
"maximum_week": 14,
"suggested": 10
},
"persons": {
"minimum": 13,
"maximum": 11
}
},
"id": 19,
"option_set_ids": [
16,
13,
17
],
"allergen_ids": [
17,
11,
18
],
"category_id": 13,
"seo": {
"title": {
"en": "Mollitia aut atque ipsa blanditiis atque et aut cum nesciunt."
},
"description": {
"en": "Rerum laborum enim ut aut itaque. Cum eligendi numquam amet commodi vel omnis nihil. Velit nostrum sequi voluptatum."
},
"url": {
"en": "http://www.vonrueden.com/sunt-eos-vel-sed.html"
}
},
"price_look_up_code": "...",
"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 |
| 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 |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 17051
[
{
"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": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 13,
"maximum": 13,
"maximum_day": 17,
"maximum_week": 17
},
"weight": {
"minimum": 15,
"maximum": 17,
"maximum_day": 15,
"maximum_week": 15,
"suggested": 14
},
"persons": {
"minimum": 18,
"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": 11,
"order": 16,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 18,
"id": 13,
"order": 10,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 18,
"id": 12,
"order": 13,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 19,
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 17,
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 17,
"code": "..."
}
],
"id": 14,
"allergens": [
{
"id": 14,
"name": "Mustard"
},
{
"id": 19,
"name": "Sesame"
},
{
"id": 18,
"name": "Celery"
}
],
"category_id": 19,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Ipsa sit in quia aut sint velit nulla."
},
"description": {
"en": "Aliquid beatae maiores et. Qui possimus quidem et. Laudantium voluptatem unde dolore nemo ut sint ut. Nihil enim iste saepe quo modi."
},
"url": {
"en": "http://kris.com/voluptatem-voluptas-sit-suscipit"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"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": 18,
"maximum": 18,
"maximum_day": 10,
"maximum_week": 13
},
"weight": {
"minimum": 14,
"maximum": 15,
"maximum_day": 13,
"maximum_week": 16,
"suggested": 11
},
"persons": {
"minimum": 18,
"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": 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": 14,
"id": 17,
"order": 15,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 14,
"id": 12,
"order": 12,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 19,
"id": 10,
"order": 10,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 15,
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 13,
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 10,
"code": "..."
}
],
"id": 10,
"allergens": [
{
"id": 11,
"name": "Nuts"
},
{
"id": 11,
"name": "Milk"
},
{
"id": 13,
"name": "Sesame"
}
],
"category_id": 10,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Et qui temporibus necessitatibus libero eaque reiciendis."
},
"description": {
"en": "Ipsam quia consequatur similique omnis saepe quia dicta praesentium. Quia corporis eum qui accusamus. Dolor est quia possimus consequatur veniam rerum et. Est nobis labore sed harum sit."
},
"url": {
"en": "http://hahn.com/nesciunt-suscipit-quisquam-debitis.html"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"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": 12,
"maximum": 15,
"maximum_day": 17,
"maximum_week": 15
},
"weight": {
"minimum": 15,
"maximum": 18,
"maximum_day": 18,
"maximum_week": 12,
"suggested": 15
},
"persons": {
"minimum": 17,
"maximum": 14
}
},
"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": true
}
],
"product_prices": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 14,
"id": 19,
"order": 12,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 17,
"id": 10,
"order": 17,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 17,
"id": 18,
"order": 18,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 13,
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 10,
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 14,
"code": "..."
}
],
"id": 14,
"allergens": [
{
"id": 15,
"name": "Sesame"
},
{
"id": 14,
"name": "Crustaceans"
},
{
"id": 18,
"name": "Celery"
}
],
"category_id": 15,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Neque ut excepturi aspernatur nam sint impedit at velit commodi sunt."
},
"description": {
"en": "Quia omnis aut in qui laudantium eligendi animi modi. Odit similique beatae ut quisquam."
},
"url": {
"en": "http://www.bechtelar.biz/aut-nemo-et-provident"
}
}
}
]