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 |
| origin | [Language: String] | Optional. Origin of the product |
PATCH /company/products/bulk HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.7.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 5542
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 14,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 16,
"maximum": 14,
"maximum_day": 10,
"maximum_week": 13
},
"weight": {
"minimum": 18,
"maximum": 18,
"maximum_day": 10,
"maximum_week": 14,
"suggested": 14
},
"persons": {
"minimum": 11,
"maximum": 19
}
},
"id": 18,
"option_set_ids": [
15,
17,
15
],
"allergen_ids": [
12,
10,
12
],
"category_id": 14,
"seo": {
"title": {
"en": "Quia corrupti aperiam nam quo repellendus porro impedit nisi laboriosam sit."
},
"description": {
"en": "Dolorem similique hic corrupti pariatur aspernatur. Accusantium vel consequatur et possimus. Accusantium tenetur ipsa voluptatem odit porro qui."
},
"url": {
"en": "http://www.schulist.com/magnam-doloribus-reprehenderit-saepe-voluptas-ut-eligendi-aut-voluptas.html"
}
},
"price_look_up_code": "...",
"code": "...",
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"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": 17,
"maximum": 11,
"maximum_day": 11,
"maximum_week": 12
},
"weight": {
"minimum": 10,
"maximum": 15,
"maximum_day": 15,
"maximum_week": 10,
"suggested": 13
},
"persons": {
"minimum": 19,
"maximum": 19
}
},
"id": 13,
"option_set_ids": [
14,
17,
14
],
"allergen_ids": [
16,
11,
12
],
"category_id": 11,
"seo": {
"title": {
"en": "Sit aut sed iure velit dolorum."
},
"description": {
"en": "Corporis cupiditate ut non molestiae eaque et doloremque. Et accusamus est modi corporis autem autem. Error corporis praesentium earum architecto quo id."
},
"url": {
"en": "https://www.gerlach.info/quia-exercitationem-impedit-eligendi-provident-quae-veritatis-quasi"
}
},
"price_look_up_code": "...",
"code": "...",
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 16,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 15,
"maximum": 12,
"maximum_day": 12,
"maximum_week": 18
},
"weight": {
"minimum": 11,
"maximum": 14,
"maximum_day": 18,
"maximum_week": 13,
"suggested": 13
},
"persons": {
"minimum": 17,
"maximum": 16
}
},
"id": 11,
"option_set_ids": [
17,
11,
16
],
"allergen_ids": [
12,
13,
18
],
"category_id": 15,
"seo": {
"title": {
"en": "Similique cupiditate alias tenetur et iste recusandae commodi in et quaerat."
},
"description": {
"en": "Provident odit facilis occaecati maiores eligendi sint. Incidunt aut fugit nostrum illo. Nulla pariatur veniam ab voluptatum."
},
"url": {
"en": "http://www.cummings.info/"
}
},
"price_look_up_code": "...",
"code": "...",
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
}
]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 |
| origin | [Language: String] | Optional. Origin of the product |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 19736
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 10,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 10,
"maximum": 19,
"maximum_day": 14,
"maximum_week": 19
},
"weight": {
"minimum": 15,
"maximum": 14,
"maximum_day": 12,
"maximum_week": 13,
"suggested": 11
},
"persons": {
"minimum": 14,
"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": 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": 14,
"id": 16,
"order": 10,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 11,
"id": 18,
"order": 15,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 19,
"id": 17,
"order": 11,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 13,
"code": "...",
"multiple_choice": true,
"choose_amount": false,
"min_different_options": 19,
"max_different_options": 11,
"min_amount_options": 15,
"max_amount_options": 17
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 11,
"code": "...",
"multiple_choice": true,
"choose_amount": false,
"min_different_options": 19,
"max_different_options": 14,
"min_amount_options": 10,
"max_amount_options": 19
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 12,
"code": "...",
"multiple_choice": false,
"choose_amount": false,
"min_different_options": 11,
"max_different_options": 17,
"min_amount_options": 11,
"max_amount_options": 14
}
],
"id": 11,
"allergens": [
{
"id": 18,
"name": "Mollusc"
},
{
"id": 17,
"name": "Egg"
},
{
"id": 14,
"name": "Mollusc"
}
],
"category_id": 13,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Laudantium pariatur qui nam dolores voluptatem doloremque deleniti quia."
},
"description": {
"en": "Odio recusandae sapiente enim pariatur consequatur dolore qui. Ut qui quia consequatur iusto. Consectetur ducimus et qui voluptate sint."
},
"url": {
"en": "https://www.wisoky.net/natus-nesciunt-voluptatem-expedita-quia-magnam-unde"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
},
{
"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": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 15,
"maximum": 19,
"maximum_day": 14,
"maximum_week": 13
},
"weight": {
"minimum": 19,
"maximum": 10,
"maximum_day": 10,
"maximum_week": 11,
"suggested": 17
},
"persons": {
"minimum": 12,
"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": 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": 12,
"id": 16,
"order": 16,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 15,
"id": 10,
"order": 14,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 17,
"id": 13,
"order": 18,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 19,
"code": "...",
"multiple_choice": false,
"choose_amount": false,
"min_different_options": 12,
"max_different_options": 13,
"min_amount_options": 13,
"max_amount_options": 16
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 19,
"code": "...",
"multiple_choice": true,
"choose_amount": true,
"min_different_options": 14,
"max_different_options": 18,
"min_amount_options": 19,
"max_amount_options": 10
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 16,
"code": "...",
"multiple_choice": false,
"choose_amount": false,
"min_different_options": 14,
"max_different_options": 11,
"min_amount_options": 10,
"max_amount_options": 16
}
],
"id": 17,
"allergens": [
{
"id": 11,
"name": "Nuts"
},
{
"id": 13,
"name": "Egg"
},
{
"id": 18,
"name": "Gluten"
}
],
"category_id": 14,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Ut reiciendis ratione assumenda est quia est sed nihil unde dolore."
},
"description": {
"en": "Et in minima ut voluptatum laborum pariatur ipsa. Iusto consequatur illo quae recusandae saepe omnis aliquid."
},
"url": {
"en": "http://www.berge.net/velit-harum-et-atque.html"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
},
{
"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": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 11,
"maximum": 13,
"maximum_day": 15,
"maximum_week": 16
},
"weight": {
"minimum": 15,
"maximum": 14,
"maximum_day": 13,
"maximum_week": 15,
"suggested": 16
},
"persons": {
"minimum": 13,
"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": 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": 13,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 12,
"id": 11,
"order": 14,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 17,
"id": 13,
"order": 10,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 17,
"code": "...",
"multiple_choice": false,
"choose_amount": false,
"min_different_options": 11,
"max_different_options": 19,
"min_amount_options": 12,
"max_amount_options": 18
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 19,
"code": "...",
"multiple_choice": false,
"choose_amount": true,
"min_different_options": 18,
"max_different_options": 13,
"min_amount_options": 12,
"max_amount_options": 18
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 11,
"code": "...",
"multiple_choice": false,
"choose_amount": false,
"min_different_options": 11,
"max_different_options": 11,
"min_amount_options": 10,
"max_amount_options": 16
}
],
"id": 17,
"allergens": [
{
"id": 18,
"name": "Mollusc"
},
{
"id": 13,
"name": "Egg"
},
{
"id": 10,
"name": "Mollusc"
}
],
"category_id": 12,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Non enim tenetur est enim doloremque ad magni explicabo."
},
"description": {
"en": "Incidunt qui libero deleniti natus ut dolor. Fugiat quam quia facere eaque. Est accusantium nisi qui eum sit aspernatur et. Ut repudiandae a ea qui enim est rem."
},
"url": {
"en": "https://sawayn.com/sunt-in-repellendus-ad-repudiandae-dolorum-numquam-ab.html"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
}
]