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": "Dr. Delbert Heidenreich IV",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"shop_ids": [
13,
10,
13
],
"seo": {
"title": {
"en": "Temporibus neque ut ut aspernatur aut quisquam ab ut iure."
},
"description": {
"en": "Quia magnam commodi cupiditate quia dignissimos soluta deserunt fugiat. Aliquam omnis exercitationem qui ab. Neque beatae non velit tempora et et unde sed. Sit ut temporibus voluptas et fugiat."
},
"url": {
"en": "http://www.hodkiewicz.info/in-et-dolores-aliquid-voluptate-autem"
}
},
"product_ids": [
13,
10,
14
]
}When returned in a response.
{
"name": "Mandy Schneider",
"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": 12,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 18,
"maximum": 14,
"maximum_day": 16,
"maximum_week": 18
},
"weight": {
"minimum": 18,
"maximum": 19,
"maximum_day": 13,
"maximum_week": 18,
"suggested": 18
},
"persons": {
"minimum": 12,
"maximum": 12
}
},
"id": 10,
"allergens": [
{
"id": 16,
"name": "Egg"
},
{
"id": 18,
"name": "Celery"
},
{
"id": 14,
"name": "Peanut"
}
],
"category_id": 12,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Explicabo architecto reiciendis eos sapiente dolorem."
},
"description": {
"en": "Est tenetur qui earum dolores qui hic. Et quod consequatur et architecto dolorum saepe voluptas. Animi totam et corporis amet fuga aut culpa."
},
"url": {
"en": "http://ferry.net/"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 11,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 10,
"maximum": 16,
"maximum_day": 19,
"maximum_week": 18
},
"weight": {
"minimum": 10,
"maximum": 14,
"maximum_day": 18,
"maximum_week": 12,
"suggested": 18
},
"persons": {
"minimum": 16,
"maximum": 13
}
},
"id": 18,
"allergens": [
{
"id": 18,
"name": "Lupine"
},
{
"id": 15,
"name": "Fish"
},
{
"id": 17,
"name": "Mollusc"
}
],
"category_id": 11,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Architecto doloremque laboriosam qui vitae et dolorem temporibus suscipit."
},
"description": {
"en": "Quisquam ut sint delectus non sed. Quo numquam itaque dignissimos est exercitationem dicta odit. Omnis sunt at a placeat. Accusantium nam natus qui fugit voluptatum qui necessitatibus."
},
"url": {
"en": "http://www.nitzsche.com/"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 17,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 10,
"maximum": 11,
"maximum_day": 16,
"maximum_week": 19
},
"weight": {
"minimum": 14,
"maximum": 16,
"maximum_day": 19,
"maximum_week": 10,
"suggested": 18
},
"persons": {
"minimum": 16,
"maximum": 19
}
},
"id": 19,
"allergens": [
{
"id": 19,
"name": "Crustaceans"
},
{
"id": 12,
"name": "Lactose"
},
{
"id": 18,
"name": "Gluten"
}
],
"category_id": 19,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Inventore dolor occaecati ut facilis eum iusto quisquam inventore ad magnam."
},
"description": {
"en": "Dolores molestiae quia sit sapiente deleniti. Iste rerum animi ducimus non soluta. Aperiam iusto et excepturi et sint eius distinctio."
},
"url": {
"en": "http://predovic.com/veritatis-dolorem-consequuntur-architecto-quia.html"
}
}
}
],
"shops": [
{
"name": "Prof. Alice O'Reilly DDS",
"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": true,
"delivery_use_intervals": true,
"allow_invoices": true,
"allow_order_comments": false,
"allow_product_comments": false,
"takeout_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": false
}
},
{
"name": "Obie Johns",
"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": true,
"takeout_use_intervals": 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": 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
}
},
{
"name": "Dasia McCullough",
"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": true,
"allow_order_comments": false,
"allow_product_comments": true,
"takeout_use_intervals": 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": 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": true
}
}
],
"id": 17,
"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": "Quia porro ut eum ut eligendi nam."
},
"description": {
"en": "Necessitatibus dicta voluptatem dolor est. Nulla voluptas hic dolore omnis voluptates sequi sed consequuntur. Voluptatem veritatis saepe nihil non voluptatibus laudantium pariatur."
},
"url": {
"en": "http://klocko.com/corporis-excepturi-tempore-minus-ipsum-odit-amet-aut"
}
}
}