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.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 5212
[
{
"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": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 13,
"maximum": 16,
"maximum_day": 16,
"maximum_week": 14
},
"weight": {
"minimum": 11,
"maximum": 10,
"maximum_day": 17,
"maximum_week": 10,
"suggested": 19
},
"persons": {
"minimum": 12,
"maximum": 17
}
},
"id": 19,
"option_set_ids": [
13,
15,
17
],
"allergen_ids": [
15,
14,
16
],
"category_id": 11,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Qui soluta sed amet illo perspiciatis."
},
"description": {
"en": "Sunt non nam qui officia qui velit. Repellendus distinctio quibusdam modi sunt. Et asperiores in ex numquam quia praesentium. Eos accusamus occaecati eos explicabo ea voluptas."
},
"url": {
"en": "http://www.dicki.com/"
}
},
"code": "..."
},
{
"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": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 13,
"maximum": 19,
"maximum_day": 19,
"maximum_week": 19
},
"weight": {
"minimum": 13,
"maximum": 14,
"maximum_day": 16,
"maximum_week": 17,
"suggested": 17
},
"persons": {
"minimum": 11,
"maximum": 10
}
},
"id": 13,
"option_set_ids": [
15,
13,
11
],
"allergen_ids": [
12,
11,
10
],
"category_id": 15,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Quibusdam praesentium ipsum officiis fuga."
},
"description": {
"en": "Impedit consequatur tenetur non aut. Consequatur sed repudiandae sint in corporis. Expedita deleniti quod in. Esse voluptatibus aspernatur magni in."
},
"url": {
"en": "http://weissnat.com/suscipit-omnis-ut-aperiam-repellendus-fugiat"
}
},
"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": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 17,
"maximum": 18,
"maximum_day": 10,
"maximum_week": 14
},
"weight": {
"minimum": 17,
"maximum": 12,
"maximum_day": 16,
"maximum_week": 14,
"suggested": 14
},
"persons": {
"minimum": 15,
"maximum": 10
}
},
"id": 10,
"option_set_ids": [
18,
13,
12
],
"allergen_ids": [
12,
17,
19
],
"category_id": 16,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Nobis corporis vitae impedit facere velit recusandae suscipit architecto."
},
"description": {
"en": "Enim architecto harum eaque atque error totam neque quaerat. Velit maxime omnis natus qui velit. Magni sapiente ex qui et aut. Ut quod non expedita beatae ullam et nobis."
},
"url": {
"en": "http://www.bednar.com/ullam-fugit-quisquam-est-quae-asperiores-nemo-ipsa"
}
},
"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: 16890
[
{
"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": 18,
"maximum": 18,
"maximum_day": 15,
"maximum_week": 18
},
"weight": {
"minimum": 16,
"maximum": 11,
"maximum_day": 12,
"maximum_week": 10,
"suggested": 13
},
"persons": {
"minimum": 16,
"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": 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": 10,
"id": 11,
"order": 15,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 13,
"id": 18,
"order": 12,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 11
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 16
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 16
}
],
"id": 12,
"allergens": [
{
"id": 15,
"name": "Celery"
},
{
"id": 13,
"name": "Milk"
},
{
"id": 19,
"name": "Milk"
}
],
"category_id": 10,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Cupiditate sed odio distinctio consequatur soluta qui neque."
},
"description": {
"en": "Commodi corrupti corrupti voluptatem dicta eum distinctio. Velit soluta perferendis dolorem alias et amet odio omnis. Autem nihil alias molestias adipisci."
},
"url": {
"en": "https://krajcik.net/sunt-aspernatur-sit-ea-non-voluptates.html"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 12,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 11,
"maximum": 17,
"maximum_day": 11,
"maximum_week": 15
},
"weight": {
"minimum": 12,
"maximum": 14,
"maximum_day": 11,
"maximum_week": 17,
"suggested": 19
},
"persons": {
"minimum": 11,
"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": 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": 19,
"order": 18,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 18,
"id": 16,
"order": 18,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 17,
"id": 12,
"order": 18,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 19
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 17
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 17
}
],
"id": 11,
"allergens": [
{
"id": 19,
"name": "Gluten"
},
{
"id": 16,
"name": "Lactose"
},
{
"id": 10,
"name": "Egg"
}
],
"category_id": 17,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Architecto quisquam quos dolorem quia et et eligendi."
},
"description": {
"en": "Impedit ipsa veniam ducimus. Placeat et possimus aut nam velit mollitia delectus. Nihil cupiditate dolore blanditiis earum."
},
"url": {
"en": "https://www.dubuque.com/ducimus-corporis-in-id-dignissimos-nesciunt-est-et"
}
},
"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": 11,
"maximum": 14,
"maximum_day": 18,
"maximum_week": 10
},
"weight": {
"minimum": 17,
"maximum": 19,
"maximum_day": 15,
"maximum_week": 13,
"suggested": 12
},
"persons": {
"minimum": 10,
"maximum": 18
}
},
"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": 17,
"order": 13,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 19,
"id": 16,
"order": 11,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 13,
"id": 18,
"order": 16,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 17
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 14
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 12
}
],
"id": 13,
"allergens": [
{
"id": 17,
"name": "Nuts"
},
{
"id": 17,
"name": "Gluten"
},
{
"id": 18,
"name": "Gluten"
}
],
"category_id": 17,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Consequuntur tempora inventore quae aut illo molestias perferendis dolorum."
},
"description": {
"en": "Enim autem dolores explicabo at. Ducimus non et placeat tenetur veritatis dolor molestiae. Ut voluptate veniam et ea fuga temporibus. Aut accusantium tenetur autem quia dolor repellat libero."
},
"url": {
"en": "http://kertzmann.com/sapiente-omnis-ipsum-ducimus-dolor"
}
},
"code": "..."
}
]