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. 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: 0.3.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 5104
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"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": 18,
"maximum": 14,
"maximum_day": 12,
"maximum_week": 17
},
"weight": {
"minimum": 15,
"maximum": 14,
"maximum_day": 18,
"maximum_week": 12,
"suggested": 18
},
"persons": {
"minimum": 13,
"maximum": 15
}
},
"id": 18,
"option_set_ids": [
15,
16,
18
],
"allergen_ids": [
18,
18,
19
],
"category_id": 19,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Omnis itaque nam eveniet nulla animi enim laborum."
},
"description": {
"en": "Doloremque error deserunt quas perspiciatis aut dolorem. Quod odit sint nesciunt qui."
},
"url": {
"en": "http://www.treutel.com/"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 19,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 10,
"maximum": 14,
"maximum_day": 11,
"maximum_week": 18
},
"weight": {
"minimum": 15,
"maximum": 11,
"maximum_day": 18,
"maximum_week": 13,
"suggested": 18
},
"persons": {
"minimum": 14,
"maximum": 11
}
},
"id": 18,
"option_set_ids": [
13,
18,
17
],
"allergen_ids": [
19,
16,
16
],
"category_id": 17,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Omnis nulla eius deserunt nam ea."
},
"description": {
"en": "In qui velit rerum earum. At quis non rem quibusdam rerum quibusdam. Ab eos est qui deserunt. Enim et reprehenderit aut distinctio. Autem cupiditate soluta consequuntur ut."
},
"url": {
"en": "http://koelpin.com/dolorum-quisquam-minima-et-voluptatibus-maxime"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 10,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 18,
"maximum": 10,
"maximum_day": 18,
"maximum_week": 11
},
"weight": {
"minimum": 17,
"maximum": 17,
"maximum_day": 19,
"maximum_week": 17,
"suggested": 13
},
"persons": {
"minimum": 16,
"maximum": 18
}
},
"id": 10,
"option_set_ids": [
18,
16,
15
],
"allergen_ids": [
11,
12,
15
],
"category_id": 16,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Minus similique tempora iste accusantium amet necessitatibus et porro."
},
"description": {
"en": "Illum quam in mollitia et deserunt sed. Quia soluta eos ipsum aut aut sint aut. Vel nam non excepturi et. Sit quia numquam tempora et omnis optio et."
},
"url": {
"en": "https://hauck.com/est-ducimus-perspiciatis-est.html"
}
},
"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. 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: 16170
[
{
"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": 15,
"maximum": 19,
"maximum_day": 13,
"maximum_week": 15
},
"weight": {
"minimum": 15,
"maximum": 18,
"maximum_day": 19,
"maximum_week": 13,
"suggested": 16
},
"persons": {
"minimum": 14,
"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": 10,
"id": 15,
"order": 18
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 12,
"id": 11,
"order": 15
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 10,
"id": 12,
"order": 13
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 10
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 11
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 15
}
],
"id": 16,
"allergens": [
{
"id": 19,
"name": "Milk"
},
{
"id": 10,
"name": "Gluten"
},
{
"id": 14,
"name": "Sulphite"
}
],
"category_id": 18,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Error temporibus iusto quas magnam molestias."
},
"description": {
"en": "Explicabo cumque quasi dolor facilis. Quia ratione magnam enim iure ut. Voluptatem harum velit nihil quisquam laudantium voluptates consequuntur."
},
"url": {
"en": "http://tillman.info/qui-quam-reprehenderit-et-labore-deleniti-voluptas"
}
},
"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": 19,
"maximum": 13,
"maximum_day": 16,
"maximum_week": 11
},
"weight": {
"minimum": 19,
"maximum": 14,
"maximum_day": 13,
"maximum_week": 17,
"suggested": 14
},
"persons": {
"minimum": 18,
"maximum": 19
}
},
"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": 11,
"id": 10,
"order": 18
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 16,
"id": 16,
"order": 18
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 10,
"id": 14,
"order": 10
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 18
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 17
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 11
}
],
"id": 19,
"allergens": [
{
"id": 15,
"name": "Mustard"
},
{
"id": 17,
"name": "Sesame"
},
{
"id": 14,
"name": "Egg"
}
],
"category_id": 18,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Odio qui corporis ipsa laudantium explicabo commodi."
},
"description": {
"en": "Quibusdam quia officiis voluptas ut. Officiis aut dolorem dolores rem vero earum. Nemo adipisci maxime quibusdam expedita deserunt neque voluptatum maiores. Ipsum quibusdam quae fuga ea minus."
},
"url": {
"en": "http://www.koelpin.biz/"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"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": 14,
"maximum": 19,
"maximum_day": 19,
"maximum_week": 15
},
"weight": {
"minimum": 14,
"maximum": 18,
"maximum_day": 13,
"maximum_week": 13,
"suggested": 19
},
"persons": {
"minimum": 12,
"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": 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": 17,
"order": 13
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 19,
"id": 10,
"order": 14
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 19,
"id": 19,
"order": 19
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 18
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 17
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 19
}
],
"id": 14,
"allergens": [
{
"id": 10,
"name": "Fish"
},
{
"id": 17,
"name": "Peanut"
},
{
"id": 14,
"name": "Mollusc"
}
],
"category_id": 10,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Blanditiis doloremque expedita natus consequuntur animi exercitationem delectus."
},
"description": {
"en": "Consequuntur ullam qui nihil eos. Et consectetur ipsam alias sint dolor aut iusto. Asperiores dignissimos et necessitatibus impedit culpa inventore."
},
"url": {
"en": "http://koepp.com/illo-recusandae-cupiditate-hic-ut.html"
}
},
"code": "..."
}
]