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/14/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: 5215
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 14,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 14,
"maximum": 16,
"maximum_day": 16,
"maximum_week": 14
},
"weight": {
"minimum": 17,
"maximum": 12,
"maximum_day": 13,
"maximum_week": 19,
"suggested": 12
},
"persons": {
"minimum": 16,
"maximum": 10
}
},
"option_set_ids": [
11,
13,
17
],
"allergen_ids": [
15,
12,
10
],
"category_id": 14,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Laboriosam ut ut voluptas ipsa sed et explicabo voluptatum nisi."
},
"description": {
"en": "Et minus asperiores omnis et consectetur aut ipsum commodi. Sapiente molestias officia dolor repellat excepturi."
},
"url": {
"en": "https://schaden.com/repudiandae-ullam-et-et-reprehenderit-aut.html"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 19,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 11,
"maximum": 19,
"maximum_day": 16,
"maximum_week": 17
},
"weight": {
"minimum": 15,
"maximum": 17,
"maximum_day": 11,
"maximum_week": 10,
"suggested": 13
},
"persons": {
"minimum": 14,
"maximum": 17
}
},
"option_set_ids": [
14,
16,
18
],
"allergen_ids": [
11,
18,
16
],
"category_id": 18,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Reiciendis illum vel autem dolor doloremque fuga cumque."
},
"description": {
"en": "Nisi illo sapiente delectus sequi non. Magni dolore beatae sapiente earum id ea quod. Quo dignissimos quos et enim. Voluptatem delectus dolorum est consequatur dolorem eius delectus."
},
"url": {
"en": "http://glover.biz/architecto-ad-qui-natus-fugiat-eligendi-ut"
}
},
"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": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 16,
"maximum": 12,
"maximum_day": 12,
"maximum_week": 12
},
"weight": {
"minimum": 14,
"maximum": 19,
"maximum_day": 19,
"maximum_week": 10,
"suggested": 17
},
"persons": {
"minimum": 17,
"maximum": 10
}
},
"option_set_ids": [
17,
19,
16
],
"allergen_ids": [
11,
16,
12
],
"category_id": 15,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Corrupti quia nostrum dolorem explicabo quod provident modi omnis."
},
"description": {
"en": "Blanditiis minus nam quibusdam veniam doloribus. Vero rem voluptatem quia ut pariatur et consequatur impedit. Voluptatem harum unde dolor ipsa. Totam ea quasi excepturi quisquam voluptas accusantium."
},
"url": {
"en": "https://steuber.org/quis-sint-doloremque-nemo-rerum-eos.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: 16931
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 11,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 13,
"maximum": 19,
"maximum_day": 11,
"maximum_week": 17
},
"weight": {
"minimum": 15,
"maximum": 11,
"maximum_day": 14,
"maximum_week": 15,
"suggested": 17
},
"persons": {
"minimum": 17,
"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": 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": 19,
"id": 16,
"order": 17,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 15,
"id": 16,
"order": 11,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 15,
"id": 14,
"order": 12,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 16
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 16
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 13
}
],
"id": 16,
"allergens": [
{
"id": 17,
"name": "Sesame"
},
{
"id": 10,
"name": "Fish"
},
{
"id": 14,
"name": "Crustaceans"
}
],
"category_id": 17,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Quos voluptatem quia expedita at expedita deleniti aut repellendus assumenda."
},
"description": {
"en": "Delectus et iusto quo optio blanditiis. Ut ab fuga quod qui magnam fugit quia. Qui quod optio minus in ipsam maiores veniam laudantium. Nostrum voluptatibus et ipsa."
},
"url": {
"en": "http://haag.com/ullam-ad-inventore-quibusdam"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 17,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 11,
"maximum": 19,
"maximum_day": 14,
"maximum_week": 15
},
"weight": {
"minimum": 19,
"maximum": 19,
"maximum_day": 18,
"maximum_week": 11,
"suggested": 11
},
"persons": {
"minimum": 14,
"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": 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": 15,
"id": 18,
"order": 11,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 16,
"id": 12,
"order": 13,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 19,
"id": 19,
"order": 10,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 17
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 18
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 10
}
],
"id": 17,
"allergens": [
{
"id": 12,
"name": "Lactose"
},
{
"id": 18,
"name": "Sesame"
},
{
"id": 12,
"name": "Celery"
}
],
"category_id": 13,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Mollitia quaerat officiis sunt sit error rerum sed placeat id."
},
"description": {
"en": "Nemo soluta eveniet deleniti vitae. In ut pariatur expedita in nostrum ullam impedit. Natus rerum reiciendis hic quibusdam totam consectetur culpa. Ut debitis ad praesentium ut quia enim."
},
"url": {
"en": "https://www.harvey.com/soluta-quis-aspernatur-inventore-iusto-est"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"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": 13,
"maximum": 10,
"maximum_day": 19,
"maximum_week": 18
},
"weight": {
"minimum": 19,
"maximum": 14,
"maximum_day": 16,
"maximum_week": 17,
"suggested": 13
},
"persons": {
"minimum": 10,
"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": 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": 10,
"id": 11,
"order": 19,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 12,
"id": 12,
"order": 13,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 10,
"id": 11,
"order": 15,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 19
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 11
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 14
}
],
"id": 15,
"allergens": [
{
"id": 12,
"name": "Mollusc"
},
{
"id": 16,
"name": "Peanut"
},
{
"id": 11,
"name": "Sesame"
}
],
"category_id": 11,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Accusamus eaque facere saepe similique."
},
"description": {
"en": "Perspiciatis asperiores aspernatur explicabo dolore aliquam hic maiores. Explicabo quia aut nobis laborum laboriosam sint qui. Nulla architecto ea exercitationem animi illo doloribus."
},
"url": {
"en": "http://moen.com/dolor-expedita-iure-officiis-sit-soluta-omnis"
}
},
"code": "..."
}
]