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. 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/10/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: 5160
[
{
"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": 11,
"maximum": 19,
"maximum_day": 17,
"maximum_week": 11
},
"weight": {
"minimum": 16,
"maximum": 17,
"maximum_day": 11,
"maximum_week": 15,
"suggested": 18
},
"persons": {
"minimum": 18,
"maximum": 16
}
},
"option_set_ids": [
11,
17,
14
],
"allergen_ids": [
17,
10,
14
],
"category_id": 16,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Explicabo provident ratione ut ut."
},
"description": {
"en": "Ipsa soluta error et at sed veritatis quis. Ut ut cumque rerum quia. A omnis sed eum et sunt. Iste rerum dolores qui libero."
},
"url": {
"en": "http://www.kuhic.com/aut-dolores-consequatur-molestiae-quibusdam-quaerat-sequi-doloremque"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"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": 12,
"maximum": 16,
"maximum_day": 13,
"maximum_week": 15
},
"weight": {
"minimum": 13,
"maximum": 12,
"maximum_day": 19,
"maximum_week": 15,
"suggested": 17
},
"persons": {
"minimum": 14,
"maximum": 10
}
},
"option_set_ids": [
15,
16,
14
],
"allergen_ids": [
19,
18,
19
],
"category_id": 19,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Consequatur cum facilis et ullam eum."
},
"description": {
"en": "Id et nihil recusandae quia blanditiis hic. Est voluptates est molestiae atque temporibus iusto facilis. Ullam et molestias aut quae quis cupiditate at. Vel ab ea ad voluptatem est fugiat distinctio."
},
"url": {
"en": "http://hamill.net/dolorem-itaque-quo-sed-amet"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 15,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 15,
"maximum": 19,
"maximum_day": 10,
"maximum_week": 14
},
"weight": {
"minimum": 11,
"maximum": 19,
"maximum_day": 16,
"maximum_week": 16,
"suggested": 13
},
"persons": {
"minimum": 13,
"maximum": 12
}
},
"option_set_ids": [
12,
15,
14
],
"allergen_ids": [
10,
19,
13
],
"category_id": 11,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Consequuntur labore dicta consequuntur nihil maiores nam iusto dolorem quod dolore."
},
"description": {
"en": "Dolores laudantium voluptatem voluptas et ipsum. Ipsam eum aspernatur doloremque eveniet placeat. Corporis qui modi omnis magnam molestias."
},
"url": {
"en": "http://crist.com/qui-autem-aut-nisi-debitis-qui-accusamus"
}
},
"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: 16053
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"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": 11,
"maximum": 16,
"maximum_day": 14,
"maximum_week": 17
},
"weight": {
"minimum": 13,
"maximum": 13,
"maximum_day": 18,
"maximum_week": 19,
"suggested": 10
},
"persons": {
"minimum": 11,
"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": 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": 16,
"id": 15,
"order": 17
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 10,
"id": 19,
"order": 14
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 10,
"id": 15,
"order": 14
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 16
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 10
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 11
}
],
"id": 10,
"allergens": [
{
"id": 10,
"name": "Fish"
},
{
"id": 18,
"name": "Sesame"
},
{
"id": 15,
"name": "Egg"
}
],
"category_id": 12,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Ut blanditiis impedit exercitationem ut corporis distinctio ad qui."
},
"description": {
"en": "Esse ab enim ut dolor vitae qui et qui. Eos libero repellat quia qui et repudiandae."
},
"url": {
"en": "http://jacobi.com/consectetur-blanditiis-in-illo-vel-animi-nihil-fugit-explicabo"
}
},
"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": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 18,
"maximum": 18,
"maximum_day": 18,
"maximum_week": 12
},
"weight": {
"minimum": 17,
"maximum": 18,
"maximum_day": 18,
"maximum_week": 15,
"suggested": 11
},
"persons": {
"minimum": 11,
"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": 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": 16,
"id": 10,
"order": 12
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 11,
"id": 10,
"order": 10
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 17,
"id": 18,
"order": 19
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 17
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 17
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 15
}
],
"id": 12,
"allergens": [
{
"id": 19,
"name": "Celery"
},
{
"id": 19,
"name": "Gluten"
},
{
"id": 14,
"name": "Sulphite"
}
],
"category_id": 10,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Eos exercitationem natus quasi voluptas facilis et molestiae autem rem."
},
"description": {
"en": "Error molestiae exercitationem placeat animi. Nihil recusandae at voluptatibus. Exercitationem aut mollitia sed."
},
"url": {
"en": "https://harber.com/quia-minima-et-a-et-fugiat.html"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"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": 15,
"maximum": 16,
"maximum_day": 17,
"maximum_week": 11
},
"weight": {
"minimum": 17,
"maximum": 10,
"maximum_day": 15,
"maximum_week": 10,
"suggested": 16
},
"persons": {
"minimum": 12,
"maximum": 17
}
},
"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": 10,
"id": 15,
"order": 15
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 14,
"id": 12,
"order": 18
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 13,
"id": 16,
"order": 15
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 10
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 15
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 13
}
],
"id": 11,
"allergens": [
{
"id": 17,
"name": "Fish"
},
{
"id": 14,
"name": "Nuts"
},
{
"id": 15,
"name": "Lactose"
}
],
"category_id": 14,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Qui doloremque odio vel voluptatibus ullam cupiditate."
},
"description": {
"en": "Recusandae ut sunt impedit ipsa et excepturi. Perferendis delectus ratione sint enim similique et. Et nemo aliquid aliquid inventore aut deserunt labore."
},
"url": {
"en": "http://leannon.com/"
}
},
"code": "..."
}
]