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.3.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 5268
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"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": 17,
"maximum": 11,
"maximum_day": 16,
"maximum_week": 13
},
"weight": {
"minimum": 18,
"maximum": 19,
"maximum_day": 19,
"maximum_week": 12,
"suggested": 13
},
"persons": {
"minimum": 16,
"maximum": 16
}
},
"id": 10,
"option_set_ids": [
10,
17,
14
],
"allergen_ids": [
11,
13,
10
],
"category_id": 10,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Aut enim amet rerum iste quis inventore enim ipsam ipsum."
},
"description": {
"en": "Quis et modi quia aut sunt nihil repellat illo. Odit debitis ea deleniti eius sunt ad tempore."
},
"url": {
"en": "http://www.lueilwitz.net/quia-fuga-autem-placeat-libero-eveniet-corporis-consectetur"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"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": 10,
"maximum": 14,
"maximum_day": 16,
"maximum_week": 16
},
"weight": {
"minimum": 12,
"maximum": 19,
"maximum_day": 19,
"maximum_week": 17,
"suggested": 15
},
"persons": {
"minimum": 11,
"maximum": 12
}
},
"id": 13,
"option_set_ids": [
17,
14,
12
],
"allergen_ids": [
15,
17,
12
],
"category_id": 19,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Earum itaque optio distinctio ut dicta aliquid ut vel et totam."
},
"description": {
"en": "Sequi ducimus sapiente odio aspernatur quasi dolor assumenda suscipit. Molestiae explicabo rerum et necessitatibus esse magni ex. Vel non nihil mollitia ea. Aut aut velit vel quae et dolor."
},
"url": {
"en": "http://herman.com/suscipit-eum-ut-aspernatur-qui-maiores-voluptate"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"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": 17,
"maximum": 10,
"maximum_day": 17,
"maximum_week": 12
},
"weight": {
"minimum": 19,
"maximum": 17,
"maximum_day": 19,
"maximum_week": 13,
"suggested": 18
},
"persons": {
"minimum": 18,
"maximum": 15
}
},
"id": 17,
"option_set_ids": [
14,
10,
10
],
"allergen_ids": [
17,
13,
15
],
"category_id": 17,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Natus voluptas nostrum consequatur odit deserunt eveniet voluptatibus."
},
"description": {
"en": "Autem nemo quasi repudiandae et enim voluptatem debitis quas. Ut ea corrupti minus qui quasi est. Maiores sunt quidem in qui vero inventore. Et vitae qui officia possimus esse veniam et."
},
"url": {
"en": "http://cruickshank.info/inventore-enim-aut-magni-autem"
}
},
"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: 16752
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 17,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 16,
"maximum": 16,
"maximum_day": 12,
"maximum_week": 13
},
"weight": {
"minimum": 19,
"maximum": 10,
"maximum_day": 19,
"maximum_week": 18,
"suggested": 17
},
"persons": {
"minimum": 16,
"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": 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": 18,
"order": 16,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 18,
"id": 14,
"order": 11,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 19,
"id": 14,
"order": 12,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 14
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 12
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 10
}
],
"id": 14,
"allergens": [
{
"id": 12,
"name": "Mustard"
},
{
"id": 13,
"name": "Mustard"
},
{
"id": 18,
"name": "Gluten"
}
],
"category_id": 18,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Sit similique omnis in exercitationem ab aliquid."
},
"description": {
"en": "Provident voluptatibus debitis tenetur sequi exercitationem. At nihil vitae voluptatem omnis repellat. Quibusdam recusandae eum et veniam commodi. Fugiat optio ab est quo."
},
"url": {
"en": "http://johnson.com/"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 16,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 16,
"maximum": 18,
"maximum_day": 13,
"maximum_week": 16
},
"weight": {
"minimum": 17,
"maximum": 11,
"maximum_day": 14,
"maximum_week": 19,
"suggested": 14
},
"persons": {
"minimum": 19,
"maximum": 10
}
},
"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": 19,
"id": 13,
"order": 12,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 17,
"id": 16,
"order": 18,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 18,
"id": 11,
"order": 14,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 18
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 19
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 15
}
],
"id": 18,
"allergens": [
{
"id": 18,
"name": "Mustard"
},
{
"id": 17,
"name": "Sesame"
},
{
"id": 15,
"name": "Lupine"
}
],
"category_id": 17,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Saepe fugiat eos suscipit nulla inventore ducimus enim unde et."
},
"description": {
"en": "Ipsam aspernatur sunt deserunt rerum neque veritatis. Quisquam facere laboriosam quidem eum consequatur id ea."
},
"url": {
"en": "http://klein.info/asperiores-id-rerum-quos-recusandae"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"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": 18,
"maximum": 12,
"maximum_day": 15,
"maximum_week": 10
},
"weight": {
"minimum": 19,
"maximum": 13,
"maximum_day": 14,
"maximum_week": 17,
"suggested": 18
},
"persons": {
"minimum": 10,
"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": 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": 10,
"id": 17,
"order": 10,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 17,
"id": 11,
"order": 17,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 19,
"id": 15,
"order": 18,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 13
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 14
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 19
}
],
"id": 19,
"allergens": [
{
"id": 12,
"name": "Gluten"
},
{
"id": 11,
"name": "Crustaceans"
},
{
"id": 19,
"name": "Lactose"
}
],
"category_id": 18,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Odit vel rerum asperiores veniam quas quis quam."
},
"description": {
"en": "Excepturi ut ratione nostrum corrupti eaque aperiam vel. Ab ducimus qui fugit quidem ut. Doloribus nemo et vitae quia quo."
},
"url": {
"en": "http://daniel.biz/nulla-est-ducimus-dolore-facere-voluptates-sunt"
}
},
"code": "..."
}
]