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": "Osvaldo Purdy V",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"shop_ids": [
19,
16,
15
],
"seo": {
"title": {
"en": "Possimus error illum expedita reiciendis sed corrupti."
},
"description": {
"en": "Excepturi odit ex est numquam quia eum. Et mollitia sit voluptatem corporis. Impedit facere omnis architecto aut esse. Adipisci repellendus quidem nisi eos voluptate incidunt non."
},
"url": {
"en": "http://kub.com/est-incidunt-necessitatibus-itaque-a-cumque-quia"
}
},
"product_ids": [
16,
12,
10
]
}When returned in a response.
{
"name": "Kraig Crist PhD",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"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": 15,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 18,
"maximum": 18,
"maximum_day": 10,
"maximum_week": 10
},
"weight": {
"minimum": 11,
"maximum": 16,
"maximum_day": 12,
"maximum_week": 15,
"suggested": 14
},
"persons": {
"minimum": 10,
"maximum": 12
}
},
"id": 11,
"allergens": [
{
"id": 11,
"name": "Fish"
},
{
"id": 11,
"name": "Sulphite"
},
{
"id": 15,
"name": "Peanut"
}
],
"category_id": 11,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Unde consequatur sequi iure optio odio necessitatibus quo sed odit."
},
"description": {
"en": "Sunt in beatae nobis adipisci. Consequatur voluptatem earum in quia. Voluptatem est suscipit voluptatum explicabo omnis ab optio quis. Placeat vero corrupti facere officiis recusandae."
},
"url": {
"en": "http://murphy.com/sed-id-ut-repellat-facere-ipsa-velit-facere-quia"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 15,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 17,
"maximum": 13,
"maximum_day": 16,
"maximum_week": 10
},
"weight": {
"minimum": 15,
"maximum": 14,
"maximum_day": 18,
"maximum_week": 11,
"suggested": 11
},
"persons": {
"minimum": 18,
"maximum": 16
}
},
"id": 17,
"allergens": [
{
"id": 19,
"name": "Egg"
},
{
"id": 19,
"name": "Mustard"
},
{
"id": 16,
"name": "Nuts"
}
],
"category_id": 12,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Minus praesentium atque explicabo omnis debitis quia error reprehenderit."
},
"description": {
"en": "Et quas et et dolor ut harum porro. Voluptas magni vero incidunt qui nihil et quae qui. Et excepturi vero impedit dolores et excepturi assumenda. Quo quaerat ipsam est sint."
},
"url": {
"en": "http://www.cormier.com/aut-sit-minima-exercitationem-non"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 17,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 13,
"maximum": 17,
"maximum_day": 16,
"maximum_week": 18
},
"weight": {
"minimum": 13,
"maximum": 16,
"maximum_day": 15,
"maximum_week": 10,
"suggested": 18
},
"persons": {
"minimum": 12,
"maximum": 11
}
},
"id": 17,
"allergens": [
{
"id": 16,
"name": "Gluten"
},
{
"id": 12,
"name": "Crustaceans"
},
{
"id": 12,
"name": "Egg"
}
],
"category_id": 17,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Libero aut dolorem aspernatur hic ipsum."
},
"description": {
"en": "Facilis aut iusto architecto ducimus dolor natus iure. Dolorum id voluptatem est velit soluta harum. Architecto officiis eum qui aut in aut perferendis."
},
"url": {
"en": "http://aufderhar.org/earum-dolorum-ut-quia-est-sit-dolorum.html"
}
}
}
],
"shops": [
{
"name": "Prof. Theodore Kulas",
"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": true,
"delivery_use_intervals": true,
"id": 10,
"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
}
},
{
"name": "Zack Jenkins",
"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,
"id": 11,
"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
}
},
{
"name": "Floyd Mueller",
"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": false,
"id": 14,
"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
}
}
],
"id": 10,
"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": "Animi quos temporibus voluptatem minima veritatis ab eius recusandae deserunt."
},
"description": {
"en": "Eos quia repellat modi consequatur rem vero in. Fugit similique accusantium ex hic voluptate fuga ut."
},
"url": {
"en": "http://www.monahan.com/inventore-accusamus-fugiat-minima-magni-ut-suscipit-ea"
}
}
}