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/17/products/bulk HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.1.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 5187
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"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": 19,
"maximum": 15,
"maximum_day": 11,
"maximum_week": 10
},
"weight": {
"minimum": 17,
"maximum": 13,
"maximum_day": 11,
"maximum_week": 13,
"suggested": 17
},
"persons": {
"minimum": 15,
"maximum": 15
}
},
"option_set_ids": [
16,
16,
17
],
"allergen_ids": [
13,
15,
18
],
"category_id": 19,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Culpa facilis adipisci vel ipsam dolorem nostrum."
},
"description": {
"en": "Reiciendis excepturi maxime quo amet quaerat impedit et iste. Ut voluptatem ea autem. Vitae qui maxime dignissimos voluptatem eveniet odit doloribus. Nisi eos harum voluptatem blanditiis quibusdam."
},
"url": {
"en": "http://funk.com/"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 18,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 11,
"maximum": 17,
"maximum_day": 13,
"maximum_week": 19
},
"weight": {
"minimum": 12,
"maximum": 18,
"maximum_day": 14,
"maximum_week": 12,
"suggested": 16
},
"persons": {
"minimum": 15,
"maximum": 13
}
},
"option_set_ids": [
16,
18,
12
],
"allergen_ids": [
10,
12,
13
],
"category_id": 10,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Dignissimos modi quos nulla voluptatem saepe libero autem suscipit."
},
"description": {
"en": "Autem molestias similique distinctio harum. Mollitia ut dolorem at ea quia. Ea eos provident excepturi dolorem. Ipsum explicabo error consequuntur eveniet similique."
},
"url": {
"en": "http://stamm.com/"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 13,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 17,
"maximum": 17,
"maximum_day": 12,
"maximum_week": 19
},
"weight": {
"minimum": 19,
"maximum": 16,
"maximum_day": 18,
"maximum_week": 11,
"suggested": 14
},
"persons": {
"minimum": 14,
"maximum": 12
}
},
"option_set_ids": [
19,
15,
18
],
"allergen_ids": [
12,
18,
19
],
"category_id": 12,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Voluptas iusto vitae suscipit est distinctio illum animi maiores."
},
"description": {
"en": "Sint deleniti perferendis sed sint. Sed voluptatum consectetur quia distinctio et. Provident pariatur ea corporis. Harum sint dolorum ullam a et. Cumque reiciendis molestiae mollitia."
},
"url": {
"en": "http://www.schroeder.info/a-nemo-molestiae-voluptatem-id-facilis-odio-facilis"
}
},
"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: 16897
[
{
"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": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 12,
"maximum": 11,
"maximum_day": 18,
"maximum_week": 13
},
"weight": {
"minimum": 19,
"maximum": 13,
"maximum_day": 15,
"maximum_week": 18,
"suggested": 15
},
"persons": {
"minimum": 15,
"maximum": 15
}
},
"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": 18,
"id": 13,
"order": 18,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 19,
"id": 11,
"order": 14,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 13,
"id": 11,
"order": 16,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 15
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 18
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 13
}
],
"id": 16,
"allergens": [
{
"id": 16,
"name": "Sulphite"
},
{
"id": 16,
"name": "Mollusc"
},
{
"id": 14,
"name": "Mollusc"
}
],
"category_id": 19,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Omnis et est non fuga ut molestias ratione."
},
"description": {
"en": "Ut eius pariatur nihil non ut dolores iste. Aut consequatur sequi aut molestias. Ullam ipsa non unde ut magnam voluptatibus. Consequatur quidem ea ut et."
},
"url": {
"en": "http://www.hermiston.com/quia-at-tempora-doloribus-totam-quis-quia-impedit-exercitationem.html"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"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": 18,
"maximum": 17,
"maximum_day": 16,
"maximum_week": 11
},
"weight": {
"minimum": 11,
"maximum": 15,
"maximum_day": 17,
"maximum_week": 10,
"suggested": 14
},
"persons": {
"minimum": 14,
"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": 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": 12,
"id": 18,
"order": 18,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 19,
"id": 14,
"order": 17,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 11,
"id": 12,
"order": 17,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 11
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 10
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 17
}
],
"id": 13,
"allergens": [
{
"id": 19,
"name": "Egg"
},
{
"id": 13,
"name": "Mollusc"
},
{
"id": 14,
"name": "Celery"
}
],
"category_id": 15,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Voluptatem corrupti qui expedita sed non occaecati."
},
"description": {
"en": "Quasi tempora aut inventore quis reiciendis repellat. Facere et consequatur rerum ullam molestias maxime est assumenda. Error aut nisi quia similique rem vel nisi quasi."
},
"url": {
"en": "http://www.bartell.org/aut-quidem-non-non-qui.html"
}
},
"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": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 16,
"maximum": 13,
"maximum_day": 10,
"maximum_week": 14
},
"weight": {
"minimum": 11,
"maximum": 18,
"maximum_day": 13,
"maximum_week": 11,
"suggested": 15
},
"persons": {
"minimum": 18,
"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": 13,
"id": 10,
"order": 18,
"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": 14,
"id": 10,
"order": 11,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 10
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 19
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 14
}
],
"id": 10,
"allergens": [
{
"id": 17,
"name": "Lactose"
},
{
"id": 13,
"name": "Celery"
},
{
"id": 14,
"name": "Soy"
}
],
"category_id": 17,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Qui et provident sit ut sunt quidem possimus ad."
},
"description": {
"en": "Excepturi autem quia molestiae et quisquam blanditiis. Dolorem dignissimos minima minus dolorem velit nostrum numquam. Sit voluptate necessitatibus occaecati odit blanditiis quos."
},
"url": {
"en": "https://www.bailey.com/a-occaecati-laboriosam-alias-eveniet"
}
},
"code": "..."
}
]