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.8.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 5465
[
{
"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": 10,
"maximum": 13,
"maximum_day": 18,
"maximum_week": 17
},
"weight": {
"minimum": 10,
"maximum": 14,
"maximum_day": 12,
"maximum_week": 11,
"suggested": 10
},
"persons": {
"minimum": 16,
"maximum": 10
}
},
"id": 15,
"option_set_ids": [
10,
12,
18
],
"allergen_ids": [
11,
13,
10
],
"category_id": 19,
"seo": {
"title": {
"en": "Magni sunt quo pariatur dolor quidem id sunt maiores sequi."
},
"description": {
"en": "Et expedita animi at id voluptas maxime consectetur. Mollitia corporis eos architecto temporibus nam aut quam. Occaecati vitae vel quia ipsum id."
},
"url": {
"en": "http://www.rippin.com/nesciunt-voluptatem-impedit-sunt-in"
}
},
"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": true,
"price_type": "PER_UNIT",
"price": 13,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 15,
"maximum": 10,
"maximum_day": 11,
"maximum_week": 11
},
"weight": {
"minimum": 17,
"maximum": 18,
"maximum_day": 10,
"maximum_week": 13,
"suggested": 16
},
"persons": {
"minimum": 19,
"maximum": 16
}
},
"id": 18,
"option_set_ids": [
19,
10,
19
],
"allergen_ids": [
10,
15,
17
],
"category_id": 16,
"seo": {
"title": {
"en": "Perferendis et excepturi animi iste similique at dolorem sapiente sunt."
},
"description": {
"en": "Voluptas at perferendis aperiam dolor dolore sed est. Dolorem quibusdam ad laudantium fuga magnam eum consequatur."
},
"url": {
"en": "http://reynolds.com/eum-facere-aut-quia-ut-est-doloribus.html"
}
},
"price_look_up_code": "...",
"code": "...",
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"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": 14,
"maximum": 10,
"maximum_day": 10,
"maximum_week": 11
},
"weight": {
"minimum": 14,
"maximum": 16,
"maximum_day": 18,
"maximum_week": 12,
"suggested": 12
},
"persons": {
"minimum": 13,
"maximum": 13
}
},
"id": 19,
"option_set_ids": [
15,
14,
12
],
"allergen_ids": [
17,
16,
10
],
"category_id": 18,
"seo": {
"title": {
"en": "Perspiciatis ipsum et non animi amet aspernatur."
},
"description": {
"en": "Blanditiis vero veritatis enim est nam aperiam. Blanditiis doloremque laborum sint voluptates. Eos rerum non omnis debitis sunt corporis minus. Quis in aspernatur aut ex."
},
"url": {
"en": "http://windler.com/"
}
},
"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: 19642
[
{
"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": 11,
"maximum": 11,
"maximum_day": 18,
"maximum_week": 12
},
"weight": {
"minimum": 13,
"maximum": 13,
"maximum_day": 18,
"maximum_week": 13,
"suggested": 11
},
"persons": {
"minimum": 12,
"maximum": 11
}
},
"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": 11,
"order": 16,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 12,
"id": 13,
"order": 10,
"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": true,
"id": 11,
"code": "...",
"multiple_choice": true,
"choose_amount": false,
"min_different_options": 16,
"max_different_options": 17,
"min_amount_options": 17,
"max_amount_options": 16
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 14,
"code": "...",
"multiple_choice": true,
"choose_amount": true,
"min_different_options": 17,
"max_different_options": 19,
"min_amount_options": 11,
"max_amount_options": 10
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 12,
"code": "...",
"multiple_choice": true,
"choose_amount": false,
"min_different_options": 19,
"max_different_options": 10,
"min_amount_options": 14,
"max_amount_options": 11
}
],
"id": 18,
"allergens": [
{
"id": 18,
"name": "Milk"
},
{
"id": 11,
"name": "Fish"
},
{
"id": 14,
"name": "Nuts"
}
],
"category_id": 15,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Sunt sed dolores inventore non nihil nemo."
},
"description": {
"en": "Consequatur tempore sint possimus nihil soluta. Voluptatibus quos cum temporibus. Quo dolores rerum id et qui."
},
"url": {
"en": "https://www.strosin.com/quo-ducimus-voluptatem-ratione-et-ab-voluptatum-eaque"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"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": 18,
"maximum": 16,
"maximum_day": 16,
"maximum_week": 15
},
"weight": {
"minimum": 14,
"maximum": 18,
"maximum_day": 16,
"maximum_week": 13,
"suggested": 13
},
"persons": {
"minimum": 15,
"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": false
}
],
"product_prices": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 13,
"id": 18,
"order": 17,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 14,
"id": 19,
"order": 18,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 13,
"id": 15,
"order": 10,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 11,
"code": "...",
"multiple_choice": false,
"choose_amount": true,
"min_different_options": 18,
"max_different_options": 11,
"min_amount_options": 19,
"max_amount_options": 18
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 18,
"code": "...",
"multiple_choice": false,
"choose_amount": false,
"min_different_options": 19,
"max_different_options": 18,
"min_amount_options": 13,
"max_amount_options": 10
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 12,
"code": "...",
"multiple_choice": true,
"choose_amount": false,
"min_different_options": 10,
"max_different_options": 14,
"min_amount_options": 17,
"max_amount_options": 16
}
],
"id": 11,
"allergens": [
{
"id": 15,
"name": "Soy"
},
{
"id": 11,
"name": "Crustaceans"
},
{
"id": 16,
"name": "Mustard"
}
],
"category_id": 14,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Corrupti repudiandae non voluptas doloremque voluptate modi."
},
"description": {
"en": "Consectetur ipsum ad cum accusamus non at cumque. Praesentium enim repellat voluptates et est omnis explicabo. Id sit aut et animi."
},
"url": {
"en": "http://gutkowski.info/aut-nobis-eius-non-ex-eum"
}
},
"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": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 17,
"maximum": 18,
"maximum_day": 10,
"maximum_week": 17
},
"weight": {
"minimum": 17,
"maximum": 16,
"maximum_day": 13,
"maximum_week": 16,
"suggested": 12
},
"persons": {
"minimum": 13,
"maximum": 11
}
},
"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": 18,
"order": 17,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 16,
"id": 12,
"order": 19,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 11,
"id": 13,
"order": 16,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 11,
"code": "...",
"multiple_choice": true,
"choose_amount": false,
"min_different_options": 12,
"max_different_options": 15,
"min_amount_options": 14,
"max_amount_options": 12
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 11,
"code": "...",
"multiple_choice": true,
"choose_amount": true,
"min_different_options": 19,
"max_different_options": 13,
"min_amount_options": 12,
"max_amount_options": 10
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 10,
"code": "...",
"multiple_choice": false,
"choose_amount": false,
"min_different_options": 15,
"max_different_options": 15,
"min_amount_options": 15,
"max_amount_options": 17
}
],
"id": 10,
"allergens": [
{
"id": 18,
"name": "Gluten"
},
{
"id": 11,
"name": "Gluten"
},
{
"id": 17,
"name": "Mollusc"
}
],
"category_id": 17,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Incidunt facere culpa cumque quaerat est rerum ducimus ipsa."
},
"description": {
"en": "Aut quaerat quod reprehenderit. Libero aliquam quam beatae non sapiente dicta magni. Minus perferendis ab minima."
},
"url": {
"en": "http://ratke.com/nemo-nobis-saepe-error-nihil-dolores-nobis-eos.html"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
}
]