Fields when send to the api inside a request.
| 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 |
| id | Int | ID of the product you want to update |
| 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 |
| origin | [Language: String] | Optional. Origin of the product |
| ingredients | [Language: String]? | Optional. Nullable. Ingredients that are in the product |
| temperature_type | String? | Optional. Nullable. The temperature type when in a latch |
| warranty_type | String? | Optional. Nullable. The type of warranty for this product |
| warranty_price | UInt? | Optional. Nullable. Price of the warranty (cents). |
| stock | company.Stock | Optional. The stock data for a product |
| daysavailable | [Int] | Optional. Array of Int |
| upfront | company.ProductUpfront | Optional. The upfront settings for a product |
| use_pickup_after | Bool | Optional. Can pickup after a certain time be done? |
| pickup_after | Time? | Optional. Nullable. Pickup of product after what time? |
| use_pickup_before | Bool | Optional. Should a product be picked up before a certain time? |
| pickup_before | Time? | Optional. Nullable. Pickup of product before what time? |
| related_products | [Int] | Optional. List of related products, with a maximum of 8 |
Fields when returned by the api in a response.
| 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 |
| origin | [Language: String] | Optional. Origin of the product |
| ingredients | [Language: String]? | Optional. Nullable. Ingredients that are in the product |
| temperature_type | String? | Optional. Nullable. The temperature type when in a latch |
| warranty_type | String? | Optional. Nullable. The type of warranty for this product |
| warranty_price | UInt? | Optional. Nullable. Price of the warranty (cents). |
| stock | company.Stock | Optional. The stock data for a product |
| daysavailable | [Int] | Optional. Array of Int |
| upfront | company.ProductUpfront | Optional. The upfront settings for a product |
| use_pickup_after | Bool | Optional. Can pickup after a certain time be done? |
| pickup_after | Time? | Optional. Nullable. Pickup of product after what time? |
| use_pickup_before | Bool | Optional. Should a product be picked up before a certain time? |
| pickup_before | Time? | Optional. Nullable. Pickup of product before what time? |
| related_products | [Int] | Optional. List of related products, with a maximum of 8 |
When used inside a request.
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"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": 10,
"maximum": 12,
"maximum_day": 13,
"maximum_week": 12
},
"weight": {
"minimum": 14,
"maximum": 10,
"maximum_day": 15,
"maximum_week": 14,
"suggested": 12
},
"persons": {
"minimum": 13,
"maximum": 18
}
},
"id": 16,
"option_set_ids": [
18,
17,
12
],
"allergen_ids": [
18,
15,
17
],
"category_id": 17,
"seo": {
"title": {
"en": "Consequatur aspernatur vitae rerum et odio ut suscipit."
},
"description": {
"en": "Quas harum molestiae eos distinctio non sint veritatis. Ratione nisi molestias molestiae in ipsam. Enim nihil non sunt quia enim quae esse."
},
"url": {
"en": "http://jones.com/suscipit-deleniti-distinctio-ut-distinctio-reprehenderit-dolores.html"
}
},
"price_look_up_code": "...",
"code": "...",
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 10,
"stock": {
"soldout": true,
"amount": 12,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
18,
16,
13
],
"upfront": {
"upfront_use_default": false,
"upfront_type": "days",
"upfront_days": 14,
"upfront_time": "12:00",
"upfront_hours": 16,
"upfront_minutes": 14
},
"use_pickup_after": true,
"pickup_after": "12:00",
"use_pickup_before": false,
"pickup_before": "12:00",
"related_products": [
16,
13,
19
]
}When returned in a response.
{
"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": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 14,
"maximum": 10,
"maximum_day": 11,
"maximum_week": 10
},
"weight": {
"minimum": 10,
"maximum": 18,
"maximum_day": 11,
"maximum_week": 18,
"suggested": 17
},
"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
}
],
"file_id": 16,
"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
}
],
"file_id": 12,
"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
}
],
"file_id": 10,
"white_background": true
}
],
"product_prices": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 19,
"id": 11,
"order": 12,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 14,
"id": 13,
"order": 15,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 19,
"id": 17,
"order": 16,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 19,
"code": "...",
"multiple_choice": true,
"choose_amount": false,
"min_different_options": 15,
"max_different_options": 10,
"min_amount_options": 13,
"max_amount_options": 18
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 10,
"code": "...",
"multiple_choice": false,
"choose_amount": true,
"min_different_options": 12,
"max_different_options": 13,
"min_amount_options": 10,
"max_amount_options": 10
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 12,
"code": "...",
"multiple_choice": false,
"choose_amount": true,
"min_different_options": 15,
"max_different_options": 19,
"min_amount_options": 17,
"max_amount_options": 18
}
],
"id": 19,
"allergens": [
{
"id": 17,
"name": "Peanut"
},
{
"id": 14,
"name": "Lactose"
},
{
"id": 10,
"name": "Lactose"
}
],
"category_id": 18,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Aut et sunt debitis placeat beatae quidem voluptas."
},
"description": {
"en": "Corporis est iste illum voluptates porro quibusdam necessitatibus sit. Et omnis itaque fugiat cum at. Ducimus porro tempora rerum laudantium. Libero repellendus debitis ut nam iure."
},
"url": {
"en": "http://www.dietrich.com/et-et-nisi-illo-consequatur.html"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 14,
"stock": {
"soldout": false,
"amount": 17,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
15,
18,
14
],
"upfront": {
"upfront_use_default": false,
"upfront_type": "days",
"upfront_days": 10,
"upfront_time": "12:00",
"upfront_hours": 14,
"upfront_minutes": 17
},
"use_pickup_after": true,
"pickup_after": "12:00",
"use_pickup_before": false,
"pickup_before": "12:00",
"related_products": [
13,
10,
15
]
}