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. |
| seo | company.SeoData | Optional. The category's webpage search engine metatags |
When used inside a request.
{
"name": "Larue Toy",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"shop_ids": [
14,
14,
10
],
"seo": {
"title": {
"en": "Dolorem dolor harum tenetur et adipisci fugit ut."
},
"description": {
"en": "Nesciunt recusandae quasi accusamus minus non ad. Sit maxime voluptatum molestiae dolores magnam non. Consectetur qui eaque expedita magni sed."
},
"url": {
"en": "http://www.gusikowski.com/"
}
},
"product_ids": [
14,
11,
18
],
"code": "..."
}When returned in a response.
{
"name": "Ms. Lydia Shields",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"products": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 17,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 16,
"maximum": 19,
"maximum_day": 14,
"maximum_week": 16
},
"weight": {
"minimum": 12,
"maximum": 11,
"maximum_day": 12,
"maximum_week": 12,
"suggested": 11
},
"persons": {
"minimum": 13,
"maximum": 11
}
},
"id": 10,
"allergens": [
{
"id": 11,
"name": "Lupine"
},
{
"id": 15,
"name": "Soy"
},
{
"id": 12,
"name": "Sulphite"
}
],
"category_id": 18,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Nulla non ex dolores natus similique ea libero illo vel sequi."
},
"description": {
"en": "Possimus dolorem ipsam accusantium a voluptatum. Omnis itaque earum et eaque omnis. Et beatae neque voluptas expedita officiis et. Voluptatibus accusantium voluptate ut molestiae modi inventore."
},
"url": {
"en": "http://www.langworth.com/"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"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": 12,
"maximum": 12,
"maximum_day": 15,
"maximum_week": 11
},
"weight": {
"minimum": 11,
"maximum": 16,
"maximum_day": 14,
"maximum_week": 19,
"suggested": 13
},
"persons": {
"minimum": 16,
"maximum": 18
}
},
"id": 15,
"allergens": [
{
"id": 12,
"name": "Lactose"
},
{
"id": 19,
"name": "Celery"
},
{
"id": 16,
"name": "Mustard"
}
],
"category_id": 15,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Hic omnis iure nam est beatae explicabo."
},
"description": {
"en": "Tenetur perspiciatis fuga nostrum ipsam facilis est quis. Non quod quia non fugiat molestiae iste. Assumenda ex atque perferendis nam et. Veritatis et ad labore et fugiat occaecati sed beatae."
},
"url": {
"en": "http://olson.info/earum-laborum-et-excepturi-fugit-asperiores-nihil"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 15,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 14,
"maximum": 12,
"maximum_day": 13,
"maximum_week": 14
},
"weight": {
"minimum": 11,
"maximum": 19,
"maximum_day": 15,
"maximum_week": 15,
"suggested": 18
},
"persons": {
"minimum": 10,
"maximum": 16
}
},
"id": 18,
"allergens": [
{
"id": 18,
"name": "Egg"
},
{
"id": 19,
"name": "Crustaceans"
},
{
"id": 13,
"name": "Milk"
}
],
"category_id": 12,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Et commodi tenetur reprehenderit aperiam ea dolorum omnis."
},
"description": {
"en": "Voluptas incidunt laborum alias et architecto. Quae voluptate qui est dolorem. Nemo accusantium sit molestiae possimus qui quam voluptate. Omnis optio commodi sit mollitia aut beatae cum."
},
"url": {
"en": "http://casper.com/error-ut-sed-molestias-consequatur"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
}
],
"shops": [
{
"name": "Ms. Antoinette Jacobson Sr.",
"active": true,
"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": false,
"allow_invoices": true,
"allow_order_comments": false,
"allow_product_comments": false,
"takeout_use_intervals": true,
"allow_order_messages": false,
"id": 18,
"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
}
],
"white_background": false
},
"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
}
],
"white_background": true
},
"url": "..."
},
{
"name": "Dr. Oswaldo Stark",
"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": true,
"takeout_use_intervals": true,
"allow_order_messages": false,
"id": 19,
"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
}
],
"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
}
],
"white_background": false
},
"url": "..."
},
{
"name": "Jamey Harber",
"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": false,
"delivery_use_intervals": true,
"allow_invoices": false,
"allow_order_comments": true,
"allow_product_comments": true,
"takeout_use_intervals": false,
"allow_order_messages": true,
"id": 16,
"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
}
],
"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
}
],
"white_background": true
},
"url": "..."
}
],
"code": "...",
"id": 11,
"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
}
],
"white_background": true
},
"seo": {
"title": {
"en": "Saepe est culpa unde sint nobis doloribus."
},
"description": {
"en": "Ipsam mollitia quis corporis sunt pariatur occaecati ut dolor. Temporibus tempora autem sunt accusantium qui eligendi. Nam non qui et. Explicabo debitis quos est maxime eos quidem fugiat."
},
"url": {
"en": "http://www.west.biz/dignissimos-architecto-rerum-excepturi-qui-id-ut-voluptate.html"
}
}
}