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": "Mr. Giovani Carter II",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"shop_ids": [
15,
15,
12
],
"seo": {
"title": {
"en": "Nisi aut iure soluta eos et voluptate dolores corrupti."
},
"description": {
"en": "Dolorum est quisquam ut itaque vero quasi nesciunt. Exercitationem nihil aut est et enim molestiae a. Repellat qui non omnis sint omnis est reprehenderit repellat."
},
"url": {
"en": "http://mclaughlin.net/repellendus-eum-provident-consequuntur-ut"
}
},
"product_ids": [
18,
10,
13
],
"code": "..."
}When returned in a response.
{
"name": "Miss Pearline Rath MD",
"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": 16,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 19,
"maximum": 18,
"maximum_day": 15,
"maximum_week": 14
},
"weight": {
"minimum": 14,
"maximum": 10,
"maximum_day": 11,
"maximum_week": 10,
"suggested": 13
},
"persons": {
"minimum": 14,
"maximum": 15
}
},
"id": 13,
"allergens": [
{
"id": 14,
"name": "Celery"
},
{
"id": 15,
"name": "Egg"
},
{
"id": 16,
"name": "Sulphite"
}
],
"category_id": 16,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Aut qui ex ea explicabo dolorum."
},
"description": {
"en": "Sint voluptatibus laborum nostrum tenetur qui quaerat. Debitis aperiam voluptatum rerum quisquam. Cupiditate et provident excepturi molestiae. Nihil autem qui quae perferendis possimus et omnis."
},
"url": {
"en": "http://waters.com/non-quos-ut-soluta-similique-molestias-consequatur-est"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 12,
"stock": {
"soldout": false,
"amount": 11,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
12,
11,
15
],
"upfront": {
"upfront_use_default": false,
"upfront_type": "days",
"upfront_days": 12,
"upfront_time": "12:00",
"upfront_hours": 19,
"upfront_minutes": 19
},
"use_pickup_after": true,
"pickup_after": "12:00",
"use_pickup_before": false,
"pickup_before": "12:00",
"related_products": [
18,
19,
12
]
},
{
"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": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 19,
"maximum": 18,
"maximum_day": 14,
"maximum_week": 17
},
"weight": {
"minimum": 13,
"maximum": 18,
"maximum_day": 17,
"maximum_week": 10,
"suggested": 15
},
"persons": {
"minimum": 17,
"maximum": 16
}
},
"id": 16,
"allergens": [
{
"id": 12,
"name": "Mustard"
},
{
"id": 13,
"name": "Mollusc"
},
{
"id": 16,
"name": "Crustaceans"
}
],
"category_id": 17,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Sunt et nihil nulla fuga similique ipsam exercitationem nobis nulla."
},
"description": {
"en": "Illum officiis animi distinctio dolorem rem tempore. Animi eum recusandae nobis voluptas. Et natus quas fugiat voluptate aut repudiandae."
},
"url": {
"en": "http://www.walker.com/"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 13,
"stock": {
"soldout": false,
"amount": 15,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
14,
16,
10
],
"upfront": {
"upfront_use_default": true,
"upfront_type": "days",
"upfront_days": 17,
"upfront_time": "12:00",
"upfront_hours": 16,
"upfront_minutes": 11
},
"use_pickup_after": true,
"pickup_after": "12:00",
"use_pickup_before": false,
"pickup_before": "12:00",
"related_products": [
12,
15,
10
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 18,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 16,
"maximum": 16,
"maximum_day": 14,
"maximum_week": 18
},
"weight": {
"minimum": 16,
"maximum": 11,
"maximum_day": 13,
"maximum_week": 17,
"suggested": 15
},
"persons": {
"minimum": 13,
"maximum": 16
}
},
"id": 10,
"allergens": [
{
"id": 15,
"name": "Soy"
},
{
"id": 17,
"name": "Lactose"
},
{
"id": 14,
"name": "Crustaceans"
}
],
"category_id": 19,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Animi nihil rerum dolor nisi culpa eaque omnis necessitatibus assumenda voluptas officia."
},
"description": {
"en": "Consequuntur ea est aut rerum aut libero quia. Qui et id quas quasi debitis eaque. Est ut nobis sunt occaecati cumque. Molestiae repellat officiis harum."
},
"url": {
"en": "https://kling.biz/laboriosam-ratione-nam-ut-mollitia-velit-consequuntur-doloribus-sed.html"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 15,
"stock": {
"soldout": false,
"amount": 13,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
16,
15,
14
],
"upfront": {
"upfront_use_default": true,
"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": [
17,
13,
14
]
}
],
"shops": [
{
"name": "Ms. Delfina Beatty DVM",
"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": true,
"delivery_use_intervals": false,
"allow_invoices": true,
"allow_order_comments": true,
"allow_product_comments": true,
"takeout_use_intervals": false,
"allow_order_messages": false,
"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": 12,
"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
}
],
"file_id": 10,
"white_background": false
},
"url": "..."
},
{
"name": "Green Kerluke",
"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": true,
"allow_invoices": true,
"allow_order_comments": false,
"allow_product_comments": false,
"takeout_use_intervals": true,
"allow_order_messages": true,
"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
}
],
"file_id": 14,
"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": 12,
"white_background": false
},
"url": "..."
},
{
"name": "Erling Bayer",
"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": true,
"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": 19,
"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": 19,
"white_background": false
},
"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
}
],
"file_id": 15,
"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": 17,
"white_background": true
},
"seo": {
"title": {
"en": "Atque rerum magnam incidunt aliquam voluptatem deleniti hic dolores id quisquam molestias."
},
"description": {
"en": "Autem tenetur corporis molestiae minus. Repudiandae alias hic aut ea non. Omnis ut at neque quia."
},
"url": {
"en": "http://ledner.com/error-non-quo-non-maxime-voluptatem-et"
}
}
}