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. |
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 |
| 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": {
"nl": "string"
},
"description": {
"nl": "string"
},
"active": true,
"only_order_in_store": true,
"shop_ids": [
12,
12,
12
],
"seo": {
"title": {
"nl": "string"
},
"description": {
"nl": "string"
},
"url": {
"nl": "string"
}
},
"product_ids": [
12,
12,
12
]
}When returned in a response.
{
"name": {
"nl": "string"
},
"description": {
"nl": "string"
},
"active": true,
"only_order_in_store": true,
"products": [
{
"id": 818,
"name": {
"nl": "Croissant"
},
"description": {
"nl": "Random product description"
},
"specialty": false,
"active": true,
"only_order_in_store": false,
"allergens": [
{
"id": 1,
"name": "1319"
},
{
"id": 2,
"name": "1320"
},
{
"id": 3,
"name": "1321"
},
{
"id": 4,
"name": "1322"
},
{
"id": 5,
"name": "1323"
},
{
"id": 7,
"name": "1325"
},
{
"id": 8,
"name": "1326"
},
{
"id": 9,
"name": "1327"
},
{
"id": 13,
"name": "1331"
},
{
"id": 14,
"name": "1332"
},
{
"id": 15,
"name": "1333"
}
],
"price_look_up_code": "570193",
"price_type": "PER_KILOGRAM",
"price": 5397,
"target_price": true,
"url_type": "none",
"url": null,
"min_max": {
"amount": {
"minimum": 1,
"maximum": null,
"maximum_day": null,
"maximum_week": null
},
"weight": {
"minimum": 0,
"maximum": null,
"maximum_day": 0,
"maximum_week": 0,
"suggested": 0
},
"persons": {
"minimum": 0,
"maximum": null
}
},
"seo": {
"title": [],
"description": [],
"url": []
},
"code": "748403",
"category_id": 435
},
{
"id": 820,
"name": {
"nl": "Multigranen pistolets"
},
"description": {
"nl": "Random product description"
},
"specialty": false,
"active": true,
"only_order_in_store": false,
"allergens": [
{
"id": 1,
"name": "1319"
},
{
"id": 4,
"name": "1322"
},
{
"id": 9,
"name": "1327"
}
],
"price_look_up_code": null,
"price_type": "PER_UNIT",
"price": 7759,
"target_price": false,
"url_type": "none",
"url": null,
"min_max": {
"amount": {
"minimum": 1,
"maximum": null,
"maximum_day": null,
"maximum_week": null
},
"weight": {
"minimum": 0,
"maximum": null,
"maximum_day": 0,
"maximum_week": 0,
"suggested": 0
},
"persons": {
"minimum": 0,
"maximum": null
}
},
"seo": {
"title": [],
"description": [],
"url": []
},
"code": "333742",
"category_id": 435
},
{
"id": 818,
"name": {
"nl": "Croissant"
},
"description": {
"nl": "Random product description"
},
"specialty": false,
"active": true,
"only_order_in_store": false,
"allergens": [
{
"id": 1,
"name": "1319"
},
{
"id": 2,
"name": "1320"
},
{
"id": 3,
"name": "1321"
},
{
"id": 4,
"name": "1322"
},
{
"id": 5,
"name": "1323"
},
{
"id": 7,
"name": "1325"
},
{
"id": 8,
"name": "1326"
},
{
"id": 9,
"name": "1327"
},
{
"id": 13,
"name": "1331"
},
{
"id": 14,
"name": "1332"
},
{
"id": 15,
"name": "1333"
}
],
"price_look_up_code": "570193",
"price_type": "PER_KILOGRAM",
"price": 5397,
"target_price": true,
"url_type": "none",
"url": null,
"min_max": {
"amount": {
"minimum": 1,
"maximum": null,
"maximum_day": null,
"maximum_week": null
},
"weight": {
"minimum": 0,
"maximum": null,
"maximum_day": 0,
"maximum_week": 0,
"suggested": 0
},
"persons": {
"minimum": 0,
"maximum": null
}
},
"seo": {
"title": [],
"description": [],
"url": []
},
"code": "748403",
"category_id": 435
}
],
"shops": [
{
"id": 359,
"name": "Cakey Bakey",
"active": true,
"address": {
"street": "Gillessteeg",
"nr": "81",
"zipcode": "4430",
"city": "Brugge",
"country": "BE",
"position": {
"latitude": 50.8503396,
"longitude": 4.3517103
}
},
"avatar": {
"resolutions": [
{
"src": "https://bakeronline.be/uploads/shop-avatars/359/180x180/charli.jpg",
"width": 180,
"height": 180
},
{
"src": "https://bakeronline.be/uploads/shop-avatars/359/360x360/charli.jpg",
"width": 300,
"height": 300
}
]
},
"banner": {
"resolutions": [
{
"src": "https://bakeronline.be/uploads/banner/359/1300x315/banketbakkerij-bundervoet.png",
"width": 153,
"height": 93
}
]
},
"allow_comments": false,
"allow_orders": true,
"delivery_use_intervals": false
},
{
"id": 359,
"name": "Cakey Bakey",
"active": true,
"address": {
"street": "Gillessteeg",
"nr": "81",
"zipcode": "4430",
"city": "Brugge",
"country": "BE",
"position": {
"latitude": 50.8503396,
"longitude": 4.3517103
}
},
"avatar": {
"resolutions": [
{
"src": "https://bakeronline.be/uploads/shop-avatars/359/180x180/charli.jpg",
"width": 180,
"height": 180
},
{
"src": "https://bakeronline.be/uploads/shop-avatars/359/360x360/charli.jpg",
"width": 300,
"height": 300
}
]
},
"banner": {
"resolutions": [
{
"src": "https://bakeronline.be/uploads/banner/359/1300x315/banketbakkerij-bundervoet.png",
"width": 153,
"height": 93
}
]
},
"allow_comments": false,
"allow_orders": true,
"delivery_use_intervals": false
},
{
"id": 359,
"name": "Cakey Bakey",
"active": true,
"address": {
"street": "Gillessteeg",
"nr": "81",
"zipcode": "4430",
"city": "Brugge",
"country": "BE",
"position": {
"latitude": 50.8503396,
"longitude": 4.3517103
}
},
"avatar": {
"resolutions": [
{
"src": "https://bakeronline.be/uploads/shop-avatars/359/180x180/charli.jpg",
"width": 180,
"height": 180
},
{
"src": "https://bakeronline.be/uploads/shop-avatars/359/360x360/charli.jpg",
"width": 300,
"height": 300
}
]
},
"banner": {
"resolutions": [
{
"src": "https://bakeronline.be/uploads/banner/359/1300x315/banketbakkerij-bundervoet.png",
"width": 153,
"height": 93
}
]
},
"allow_comments": false,
"allow_orders": true,
"delivery_use_intervals": false
}
],
"id": 12,
"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": {
"nl": "string"
},
"description": {
"nl": "string"
},
"url": {
"nl": "string"
}
}
}