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": "Nyah Stiedemann",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"shop_ids": [
14,
13,
15
],
"seo": {
"title": {
"en": "Eaque sapiente vero quam optio rerum officia labore rerum."
},
"description": {
"en": "Sint doloribus ab totam et harum et. Ut mollitia dolor sunt quis esse. Voluptatem odio ex maxime aut. Perferendis inventore ducimus qui quo facilis ut deleniti."
},
"url": {
"en": "https://www.bartoletti.com/in-voluptatem-qui-explicabo-illo-dolores-rerum"
}
},
"product_ids": [
11,
15,
18
]
}When returned in a response.
{
"name": "Mr. Moises Collier",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"products": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 14,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 14,
"maximum": 10,
"maximum_day": 17,
"maximum_week": 14
},
"weight": {
"minimum": 19,
"maximum": 15,
"maximum_day": 15,
"maximum_week": 10,
"suggested": 15
},
"persons": {
"minimum": 12,
"maximum": 18
}
},
"id": 10,
"allergens": [
{
"id": 17,
"name": "Fish"
},
{
"id": 15,
"name": "Lupine"
},
{
"id": 11,
"name": "Lactose"
}
],
"category_id": 16,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Error vero sapiente autem inventore quas."
},
"description": {
"en": "Ullam necessitatibus tenetur reiciendis nam. Nihil rerum repudiandae incidunt aut eos odit."
},
"url": {
"en": "http://marquardt.com/"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 10,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 12,
"maximum": 15,
"maximum_day": 19,
"maximum_week": 18
},
"weight": {
"minimum": 16,
"maximum": 10,
"maximum_day": 18,
"maximum_week": 14,
"suggested": 14
},
"persons": {
"minimum": 14,
"maximum": 18
}
},
"id": 12,
"allergens": [
{
"id": 14,
"name": "Fish"
},
{
"id": 10,
"name": "Lactose"
},
{
"id": 13,
"name": "Nuts"
}
],
"category_id": 16,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Molestias et ad quos deserunt earum maiores sunt."
},
"description": {
"en": "Excepturi voluptatem pariatur unde quis voluptatem fugit. Dolor ad consequuntur laboriosam provident."
},
"url": {
"en": "http://schulist.org/"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 13,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 18,
"maximum": 10,
"maximum_day": 18,
"maximum_week": 17
},
"weight": {
"minimum": 18,
"maximum": 14,
"maximum_day": 13,
"maximum_week": 13,
"suggested": 19
},
"persons": {
"minimum": 14,
"maximum": 17
}
},
"id": 13,
"allergens": [
{
"id": 13,
"name": "Sulphite"
},
{
"id": 15,
"name": "Mustard"
},
{
"id": 10,
"name": "Milk"
}
],
"category_id": 18,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Porro est non consectetur voluptatem blanditiis sunt totam nostrum."
},
"description": {
"en": "Voluptas id laudantium modi minus qui. Maiores tempora sequi distinctio tenetur. Ad fugit odit autem."
},
"url": {
"en": "http://rogahn.net/provident-reiciendis-ipsum-voluptatem-molestiae"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
}
],
"shops": [
{
"name": "Colton Von",
"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": false,
"allow_invoices": false,
"allow_order_comments": true,
"allow_product_comments": false,
"takeout_use_intervals": false,
"allow_order_messages": true,
"id": 15,
"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": false
},
"url": "..."
},
{
"name": "Marjory Schmidt",
"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": true,
"allow_invoices": false,
"allow_order_comments": false,
"allow_product_comments": true,
"takeout_use_intervals": true,
"allow_order_messages": true,
"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": "Buford Huel",
"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": true,
"allow_order_comments": true,
"allow_product_comments": true,
"takeout_use_intervals": true,
"allow_order_messages": true,
"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
}
],
"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": "..."
}
],
"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": false
},
"seo": {
"title": {
"en": "Et ut animi minus inventore vel et libero totam."
},
"description": {
"en": "Voluptas rerum exercitationem voluptate rem nemo. Suscipit quidem earum reiciendis nobis aut distinctio. Sit in nobis non vitae sequi."
},
"url": {
"en": "http://ohara.com/rerum-deleniti-neque-tempora-quasi-beatae-consequuntur"
}
}
}