Fields when send to the api inside a request.
| Field | Type | Description |
|---|---|---|
| name | [Language: String] | Translated category name |
| description | [Language: String] | Description of this category |
| active | Bool | A boolean value |
| 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 |
| shop_ids | [Int] | Minimum 1. IDs of the shops the category will be available for |
| seo | company.SeoData | Optional. The category's webpage search engine metatags |
| product_ids | [Int] | Optional. Set the order of the products in a category by setting the IDs of the products in the right order. You can't add or remove products, only change the order. Don't set this field if you don't want to make changes. |
| code | String? | Optional. Nullable. A custom code. You can set this to your own code and use this field to map your categories to Bakeronline categories |
Fields when returned by the api in a response.
| Field | Type | Description |
|---|---|---|
| name | [Language: String] | Translated category name |
| description | [Language: String] | Description of this category |
| active | Bool | A boolean value |
| 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 |
| products | [company.Product.simple] | Array of company.Product.simple |
| shops | [company.Shop.simple] | Array of company.Shop.simple |
| code | String? | Nullable. A custom code. You can set this to your own code and use this field to map your categories to Bakeronline categories |
| id | Int | ID of the category |
| banner | Image? | Nullable. |
| overview_image | Image? | Nullable. |
| seo | company.SeoData | Optional. The category's webpage search engine metatags |
When used inside a request.
{
"name": "Izabella Williamson",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"shop_ids": [
11,
14,
17
],
"seo": {
"title": {
"en": "Omnis sed eum eum voluptatem qui."
},
"description": {
"en": "Omnis voluptas laboriosam reiciendis consequatur earum exercitationem. Consectetur praesentium earum et qui. Assumenda et est pariatur nostrum aperiam."
},
"url": {
"en": "https://www.schiller.biz/magni-et-corporis-corporis-velit-commodi-provident-animi"
}
},
"product_ids": [
11,
14,
18
],
"code": "..."
}When returned in a response.
{
"name": "Miss Mozell Boehm II",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"products": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 11,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 10,
"maximum": 16,
"maximum_day": 15,
"maximum_week": 13
},
"weight": {
"minimum": 18,
"maximum": 11,
"maximum_day": 15,
"maximum_week": 18,
"suggested": 19
},
"persons": {
"minimum": 18,
"maximum": 17
}
},
"id": 17,
"allergens": [
{
"id": 19,
"name": "Mollusc"
},
{
"id": 18,
"name": "Celery"
},
{
"id": 13,
"name": "Gluten"
}
],
"category_id": 14,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Eum distinctio rerum eaque aut vero sed eum delectus."
},
"description": {
"en": "Fuga nihil ut enim qui incidunt laborum asperiores est. Repellendus praesentium alias quas sequi. Autem perferendis repudiandae praesentium ducimus pariatur temporibus voluptates ipsa."
},
"url": {
"en": "http://graham.net/"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 12,
"stock": {
"soldout": true,
"amount": 19,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
16,
14,
16
],
"upfront": {
"upfront_use_default": true,
"upfront_type": "days",
"upfront_days": 18,
"upfront_time": "12:00",
"upfront_hours": 11,
"upfront_minutes": 16
},
"use_pickup_after": false,
"pickup_after": "12:00",
"use_pickup_before": true,
"pickup_before": "12:00",
"related_products": [
14,
11,
10
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 12,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 19,
"maximum": 12,
"maximum_day": 18,
"maximum_week": 10
},
"weight": {
"minimum": 18,
"maximum": 13,
"maximum_day": 18,
"maximum_week": 17,
"suggested": 13
},
"persons": {
"minimum": 19,
"maximum": 15
}
},
"id": 19,
"allergens": [
{
"id": 13,
"name": "Crustaceans"
},
{
"id": 12,
"name": "Peanut"
},
{
"id": 13,
"name": "Celery"
}
],
"category_id": 17,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Quae dolor ut ut hic delectus voluptatum nobis et veritatis omnis."
},
"description": {
"en": "Aut dolor eveniet quas velit nulla omnis. Deleniti fugit architecto accusamus sequi est ex expedita. Voluptatem maxime mollitia dolorum. In cum hic reiciendis."
},
"url": {
"en": "http://block.com/laudantium-similique-sed-quibusdam.html"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 14,
"stock": {
"soldout": false,
"amount": 19,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
13,
15,
15
],
"upfront": {
"upfront_use_default": true,
"upfront_type": "days",
"upfront_days": 17,
"upfront_time": "12:00",
"upfront_hours": 15,
"upfront_minutes": 18
},
"use_pickup_after": true,
"pickup_after": "12:00",
"use_pickup_before": false,
"pickup_before": "12:00",
"related_products": [
15,
14,
14
]
},
{
"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": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 19,
"maximum": 19,
"maximum_day": 19,
"maximum_week": 11
},
"weight": {
"minimum": 15,
"maximum": 16,
"maximum_day": 13,
"maximum_week": 10,
"suggested": 18
},
"persons": {
"minimum": 17,
"maximum": 19
}
},
"id": 16,
"allergens": [
{
"id": 19,
"name": "Lupine"
},
{
"id": 16,
"name": "Crustaceans"
},
{
"id": 19,
"name": "Peanut"
}
],
"category_id": 12,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Harum vel laudantium nulla earum rerum quod sit omnis facere suscipit harum."
},
"description": {
"en": "Tempore eveniet voluptatem asperiores quis nisi recusandae qui. Culpa et sit quis aut vel blanditiis. Maiores cumque enim expedita quae quia commodi non. Nemo natus dolores quia molestias."
},
"url": {
"en": "http://www.wisoky.com/"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 15,
"stock": {
"soldout": true,
"amount": 17,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
19,
13,
18
],
"upfront": {
"upfront_use_default": false,
"upfront_type": "days",
"upfront_days": 19,
"upfront_time": "12:00",
"upfront_hours": 10,
"upfront_minutes": 13
},
"use_pickup_after": true,
"pickup_after": "12:00",
"use_pickup_before": true,
"pickup_before": "12:00",
"related_products": [
14,
18,
12
]
}
],
"shops": [
{
"name": "Hans Dach",
"active": false,
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": false,
"allow_orders": false,
"delivery_use_intervals": false,
"allow_invoices": false,
"allow_order_comments": false,
"allow_product_comments": false,
"takeout_use_intervals": true,
"allow_order_messages": true,
"id": 17,
"avatar": {
"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": 17,
"white_background": true
},
"banner": {
"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": 11,
"white_background": false
},
"url": "..."
},
{
"name": "Bud Ondricka",
"active": true,
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": false,
"allow_orders": true,
"delivery_use_intervals": true,
"allow_invoices": false,
"allow_order_comments": true,
"allow_product_comments": false,
"takeout_use_intervals": false,
"allow_order_messages": false,
"id": 13,
"avatar": {
"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": 13,
"white_background": true
},
"banner": {
"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
},
"url": "..."
},
{
"name": "Hillary Wilderman",
"active": false,
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": true,
"allow_orders": false,
"delivery_use_intervals": true,
"allow_invoices": true,
"allow_order_comments": false,
"allow_product_comments": true,
"takeout_use_intervals": true,
"allow_order_messages": true,
"id": 12,
"avatar": {
"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
},
"banner": {
"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": 11,
"white_background": false
},
"url": "..."
}
],
"code": "...",
"id": 15,
"banner": {
"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": false
},
"overview_image": {
"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": false
},
"seo": {
"title": {
"en": "Ut eligendi non nesciunt corrupti ex et expedita autem velit."
},
"description": {
"en": "Possimus fuga iure libero corrupti enim occaecati debitis. Voluptatem eius et maxime expedita nesciunt id animi. Libero eligendi earum dolore id."
},
"url": {
"en": "http://ondricka.com/"
}
}
}