POST /company/companies/@id/products/bulk
This endpoint requires authentication.
| Header | Value |
|---|---|
| Authorization | Set the value to Bearer + + access_token |
Replace the @ keywords in the URL with their corresponding value.
A dictionary with fields
| Field | Type | Description |
|---|---|---|
| id | Int | Company ID. Create multiple products in this company |
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: [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 |
| 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 |
POST /company/companies/16/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: 5172
[
{
"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": 19,
"maximum_day": 10,
"maximum_week": 14
},
"weight": {
"minimum": 17,
"maximum": 10,
"maximum_day": 13,
"maximum_week": 11,
"suggested": 15
},
"persons": {
"minimum": 10,
"maximum": 11
}
},
"option_set_ids": [
12,
17,
11
],
"allergen_ids": [
11,
10,
17
],
"category_id": 14,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Corporis libero quaerat ea libero qui sapiente animi et earum."
},
"description": {
"en": "Sunt fugit provident hic debitis enim illo. Ipsam consequatur eum voluptas assumenda deleniti. Qui ad iure aperiam ut."
},
"url": {
"en": "https://frami.com/praesentium-quia-distinctio-minus-sequi-rem.html"
}
},
"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": 15,
"maximum": 16,
"maximum_day": 14,
"maximum_week": 10
},
"weight": {
"minimum": 15,
"maximum": 13,
"maximum_day": 12,
"maximum_week": 19,
"suggested": 17
},
"persons": {
"minimum": 15,
"maximum": 18
}
},
"option_set_ids": [
10,
15,
18
],
"allergen_ids": [
16,
11,
13
],
"category_id": 18,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Aut aut sint sit nulla dicta et qui nisi est expedita."
},
"description": {
"en": "Omnis et eum et mollitia. Voluptatem sunt repudiandae culpa. Modi aliquid iusto ea reiciendis explicabo qui ut doloremque. Provident odio temporibus qui porro voluptate."
},
"url": {
"en": "http://heidenreich.com/expedita-nihil-incidunt-unde-veniam-ut-eum-explicabo"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"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": 16,
"maximum": 18,
"maximum_day": 15,
"maximum_week": 18
},
"weight": {
"minimum": 12,
"maximum": 14,
"maximum_day": 15,
"maximum_week": 16,
"suggested": 12
},
"persons": {
"minimum": 10,
"maximum": 13
}
},
"option_set_ids": [
12,
18,
16
],
"allergen_ids": [
12,
12,
16
],
"category_id": 11,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Numquam non dolorem cum rerum."
},
"description": {
"en": "Aperiam non mollitia rem quam ducimus eaque odio. Fugiat provident ex maxime est. Impedit vel eveniet qui dolor. Dolor dolorum sapiente molestias in architecto."
},
"url": {
"en": "http://www.macejkovic.com/repellendus-sed-sit-omnis-est-voluptatem-praesentium.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. 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: 16813
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 10,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 18,
"maximum": 12,
"maximum_day": 17,
"maximum_week": 14
},
"weight": {
"minimum": 11,
"maximum": 19,
"maximum_day": 18,
"maximum_week": 18,
"suggested": 13
},
"persons": {
"minimum": 18,
"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": 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": 14,
"id": 18,
"order": 19,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 10,
"id": 17,
"order": 10,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 17,
"id": 18,
"order": 15,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 17
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 16
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 18
}
],
"id": 19,
"allergens": [
{
"id": 10,
"name": "Egg"
},
{
"id": 18,
"name": "Soy"
},
{
"id": 12,
"name": "Sulphite"
}
],
"category_id": 16,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Impedit ut facere soluta non vel omnis rerum et."
},
"description": {
"en": "Adipisci nemo veritatis aut est natus. Consequatur aperiam blanditiis occaecati fugiat soluta consequatur. Delectus nihil praesentium minima vero laboriosam iure. Aut est delectus fugit."
},
"url": {
"en": "http://goodwin.com/"
}
},
"code": "..."
},
{
"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": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 14,
"maximum": 17,
"maximum_day": 15,
"maximum_week": 11
},
"weight": {
"minimum": 11,
"maximum": 14,
"maximum_day": 14,
"maximum_week": 16,
"suggested": 11
},
"persons": {
"minimum": 13,
"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": 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": 11,
"id": 18,
"order": 18,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 19,
"id": 16,
"order": 12,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 19,
"id": 13,
"order": 10,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 15
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 11
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 17
}
],
"id": 18,
"allergens": [
{
"id": 12,
"name": "Milk"
},
{
"id": 12,
"name": "Crustaceans"
},
{
"id": 13,
"name": "Sesame"
}
],
"category_id": 18,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Omnis esse at et nihil corrupti quia."
},
"description": {
"en": "Laboriosam voluptas dolor commodi sunt itaque mollitia vel officia. Hic dolores placeat aut ratione pariatur voluptas similique. Ab quia officia incidunt quis ullam est."
},
"url": {
"en": "http://www.jacobs.info/facilis-quidem-maiores-harum.html"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"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": 10,
"maximum": 16,
"maximum_day": 11,
"maximum_week": 17
},
"weight": {
"minimum": 12,
"maximum": 15,
"maximum_day": 10,
"maximum_week": 15,
"suggested": 12
},
"persons": {
"minimum": 19,
"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": 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": 16,
"id": 16,
"order": 17,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 14,
"id": 18,
"order": 18,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 12,
"id": 10,
"order": 16,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 18
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 11
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 17
}
],
"id": 14,
"allergens": [
{
"id": 11,
"name": "Gluten"
},
{
"id": 11,
"name": "Mollusc"
},
{
"id": 16,
"name": "Mollusc"
}
],
"category_id": 17,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Iusto nam optio consequatur ut quod nihil."
},
"description": {
"en": "Exercitationem non cum dignissimos quae pariatur. Est repudiandae eaque et sit laboriosam aut. Ipsum delectus omnis facere magnam nesciunt."
},
"url": {
"en": "http://www.nolan.biz/qui-eveniet-consequuntur-inventore-harum-ut"
}
},
"code": "..."
}
]