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 |
| 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 |
POST /company/companies/18/products/bulk HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.5.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 5137
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"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": 14,
"maximum": 10,
"maximum_day": 11,
"maximum_week": 16
},
"weight": {
"minimum": 17,
"maximum": 13,
"maximum_day": 18,
"maximum_week": 13,
"suggested": 12
},
"persons": {
"minimum": 16,
"maximum": 13
}
},
"option_set_ids": [
19,
15,
18
],
"allergen_ids": [
13,
13,
11
],
"category_id": 16,
"seo": {
"title": {
"en": "Sit explicabo accusantium ea dolorum porro et dolorem nam mollitia."
},
"description": {
"en": "Aliquid recusandae ut voluptatibus veritatis deserunt eveniet illo. Voluptatem doloremque qui earum ea voluptatem. Iste ea omnis ipsa quos. Vero qui quo sint neque error consequuntur ut repellat."
},
"url": {
"en": "http://www.batz.com/qui-molestias-itaque-dolorem-dolores-aut-est"
}
},
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 13,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 14,
"maximum": 16,
"maximum_day": 10,
"maximum_week": 15
},
"weight": {
"minimum": 18,
"maximum": 19,
"maximum_day": 15,
"maximum_week": 13,
"suggested": 16
},
"persons": {
"minimum": 12,
"maximum": 12
}
},
"option_set_ids": [
12,
16,
16
],
"allergen_ids": [
14,
17,
13
],
"category_id": 14,
"seo": {
"title": {
"en": "Repellat quibusdam nemo sed dolore modi non laborum maiores."
},
"description": {
"en": "Consequatur est nostrum dolore quam iusto perferendis. Aliquid ipsa explicabo distinctio assumenda. Qui ut iusto minus facilis qui. Quia tenetur iste non."
},
"url": {
"en": "http://www.hermiston.com/optio-neque-temporibus-quam"
}
},
"price_look_up_code": "...",
"code": "..."
},
{
"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": 18,
"maximum": 14,
"maximum_day": 14,
"maximum_week": 11
},
"weight": {
"minimum": 10,
"maximum": 16,
"maximum_day": 15,
"maximum_week": 11,
"suggested": 12
},
"persons": {
"minimum": 19,
"maximum": 19
}
},
"option_set_ids": [
17,
15,
12
],
"allergen_ids": [
16,
12,
14
],
"category_id": 19,
"seo": {
"title": {
"en": "Tenetur maxime culpa nesciunt dolor et."
},
"description": {
"en": "Ut doloremque voluptas corrupti eius suscipit explicabo. Et culpa facilis sunt accusamus quod beatae iusto. Iste sint magni doloribus velit."
},
"url": {
"en": "http://hyatt.biz/"
}
},
"price_look_up_code": "...",
"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 |
| 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 |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 17177
[
{
"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": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 15,
"maximum": 19,
"maximum_day": 17,
"maximum_week": 13
},
"weight": {
"minimum": 16,
"maximum": 16,
"maximum_day": 12,
"maximum_week": 10,
"suggested": 11
},
"persons": {
"minimum": 16,
"maximum": 14
}
},
"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": 17,
"order": 14,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 19,
"id": 13,
"order": 13,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 16,
"id": 12,
"order": 12,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 13,
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 10,
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 16,
"code": "..."
}
],
"id": 10,
"allergens": [
{
"id": 18,
"name": "Crustaceans"
},
{
"id": 18,
"name": "Soy"
},
{
"id": 16,
"name": "Nuts"
}
],
"category_id": 12,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Doloribus eum expedita repudiandae autem dolorum esse ut."
},
"description": {
"en": "Accusantium qui cupiditate repellendus nobis. Mollitia nihil qui recusandae aliquid culpa. Omnis ipsam hic aut magni quia quia."
},
"url": {
"en": "http://block.com/sint-quia-sint-et-quibusdam-ipsa-sint.html"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"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": 13,
"maximum_day": 11,
"maximum_week": 13
},
"weight": {
"minimum": 12,
"maximum": 10,
"maximum_day": 19,
"maximum_week": 12,
"suggested": 17
},
"persons": {
"minimum": 17,
"maximum": 14
}
},
"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": 18,
"id": 16,
"order": 16,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 11,
"id": 13,
"order": 16,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 18,
"id": 13,
"order": 18,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 11,
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 12,
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 13,
"code": "..."
}
],
"id": 11,
"allergens": [
{
"id": 11,
"name": "Egg"
},
{
"id": 16,
"name": "Milk"
},
{
"id": 11,
"name": "Egg"
}
],
"category_id": 16,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Eum porro sunt aut architecto pariatur in non ut et."
},
"description": {
"en": "Ut tempora pariatur occaecati. Blanditiis nobis rerum voluptatibus. Sint aut quasi expedita. Tenetur similique illo amet corrupti voluptatem. Sint quos qui est itaque illum earum."
},
"url": {
"en": "http://bergstrom.biz/explicabo-quasi-totam-sed-quisquam-sed-ut.html"
}
}
},
{
"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": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 18,
"maximum": 19,
"maximum_day": 16,
"maximum_week": 10
},
"weight": {
"minimum": 10,
"maximum": 15,
"maximum_day": 12,
"maximum_week": 14,
"suggested": 18
},
"persons": {
"minimum": 18,
"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": 17,
"id": 12,
"order": 10,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 13,
"id": 11,
"order": 12,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 14,
"id": 10,
"order": 14,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 10,
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 10,
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 18,
"code": "..."
}
],
"id": 12,
"allergens": [
{
"id": 19,
"name": "Sesame"
},
{
"id": 17,
"name": "Nuts"
},
{
"id": 17,
"name": "Mollusc"
}
],
"category_id": 18,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Beatae beatae pariatur quo quia laudantium omnis eos iusto voluptas."
},
"description": {
"en": "Animi rerum illum fugiat architecto dolor id omnis. Sit non ut voluptatem nesciunt. Saepe accusamus veritatis incidunt accusamus. Repellendus dolor dignissimos sequi a dolor quo."
},
"url": {
"en": "http://www.jaskolski.biz/id-at-optio-labore-praesentium-alias-dolor.html"
}
}
}
]