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": "Ms. Gisselle Hill V",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"shop_ids": [
12,
19,
11
],
"seo": {
"title": {
"en": "Ut quis in molestiae temporibus qui quidem sunt hic."
},
"description": {
"en": "Quasi iusto veniam quia maxime ab omnis et. Accusamus quos laborum consectetur a consequuntur molestiae tempore. Pariatur necessitatibus saepe commodi aut."
},
"url": {
"en": "http://www.gutkowski.com/animi-modi-illo-et-tempore-et-quidem-sint-voluptates"
}
},
"product_ids": [
12,
10,
16
]
}When returned in a response.
{
"name": "Lexus Hayes",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"products": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 12,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 17,
"maximum": 13,
"maximum_day": 19,
"maximum_week": 14
},
"weight": {
"minimum": 16,
"maximum": 10,
"maximum_day": 19,
"maximum_week": 18,
"suggested": 10
},
"persons": {
"minimum": 17,
"maximum": 15
}
},
"id": 12,
"allergens": [
{
"id": 13,
"name": "Mollusc"
},
{
"id": 10,
"name": "Mollusc"
},
{
"id": 12,
"name": "Soy"
}
],
"category_id": 12,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Blanditiis voluptate eveniet amet voluptatem."
},
"description": {
"en": "Minus et nihil laudantium fugit rerum velit sapiente soluta. Suscipit quia veniam necessitatibus. Sunt cum quae vel labore neque et. Quas mollitia sed enim eligendi fugiat nesciunt."
},
"url": {
"en": "http://morar.com/a-eius-quia-qui-et.html"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 14,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 19,
"maximum": 14,
"maximum_day": 10,
"maximum_week": 12
},
"weight": {
"minimum": 10,
"maximum": 15,
"maximum_day": 19,
"maximum_week": 13,
"suggested": 12
},
"persons": {
"minimum": 14,
"maximum": 16
}
},
"id": 10,
"allergens": [
{
"id": 16,
"name": "Celery"
},
{
"id": 12,
"name": "Lactose"
},
{
"id": 14,
"name": "Celery"
}
],
"category_id": 12,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Dicta et veritatis consequuntur commodi omnis facilis quis enim tempora dolor animi."
},
"description": {
"en": "Necessitatibus libero qui exercitationem minima ipsam voluptatem. Officia velit officia earum porro dolores maiores. Voluptatem nihil velit debitis sint voluptate."
},
"url": {
"en": "https://lowe.com/vel-eum-quo-ipsam-dolores-consequuntur-mollitia-maiores-voluptatibus.html"
}
},
"code": "..."
},
{
"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": 10,
"maximum": 19,
"maximum_day": 11,
"maximum_week": 12
},
"weight": {
"minimum": 14,
"maximum": 15,
"maximum_day": 19,
"maximum_week": 16,
"suggested": 11
},
"persons": {
"minimum": 19,
"maximum": 16
}
},
"id": 18,
"allergens": [
{
"id": 12,
"name": "Soy"
},
{
"id": 12,
"name": "Gluten"
},
{
"id": 17,
"name": "Egg"
}
],
"category_id": 12,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Dolores voluptates cum aut rerum blanditiis consequatur accusantium."
},
"description": {
"en": "Sed ipsam architecto mollitia laboriosam. Accusantium voluptatem qui explicabo. Voluptatem omnis voluptatem qui et."
},
"url": {
"en": "http://www.price.com/"
}
},
"code": "..."
}
],
"shops": [
{
"name": "Marianna Gibson",
"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,
"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": false
}
},
{
"name": "Victoria Ward",
"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": true,
"delivery_use_intervals": 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
}
},
{
"name": "Don Kris",
"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": 12,
"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
}
}
],
"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": false
},
"seo": {
"title": {
"en": "Consequatur qui nemo laborum ratione est facilis consequatur ut."
},
"description": {
"en": "Totam dolores occaecati dolores hic ut. Nihil qui neque reprehenderit consectetur aut laboriosam reiciendis quia. Beatae temporibus fugit vel repellat qui occaecati ad."
},
"url": {
"en": "http://www.kub.com/rerum-nulla-cumque-earum-nihil-corrupti-sint-pariatur"
}
}
}