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": "Miss Noemi Crona DVM",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"shop_ids": [
19,
13,
18
],
"seo": {
"title": {
"en": "Animi culpa repellat quis et exercitationem."
},
"description": {
"en": "Hic rem magnam itaque. Repellat tempore nobis quis vero. Ut recusandae esse nulla."
},
"url": {
"en": "http://aufderhar.com/sed-dolorem-architecto-ea-nostrum-non"
}
},
"product_ids": [
17,
11,
17
]
}When returned in a response.
{
"name": "Ms. Jailyn Reinger",
"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": true,
"price_type": "PER_UNIT",
"price": 16,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 19,
"maximum": 17,
"maximum_day": 14,
"maximum_week": 14
},
"weight": {
"minimum": 16,
"maximum": 16,
"maximum_day": 18,
"maximum_week": 16,
"suggested": 15
},
"persons": {
"minimum": 17,
"maximum": 11
}
},
"id": 13,
"allergens": [
{
"id": 14,
"name": "Celery"
},
{
"id": 13,
"name": "Gluten"
},
{
"id": 11,
"name": "Lactose"
}
],
"category_id": 10,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Voluptas fugit sequi sequi dignissimos sunt doloremque."
},
"description": {
"en": "Quas earum soluta earum beatae vitae. Nostrum rerum deleniti iste ad qui voluptatem. Quod quos consequuntur quibusdam excepturi."
},
"url": {
"en": "http://considine.biz/eaque-consequatur-nesciunt-quod-dolore-est-omnis-animi-accusamus"
}
},
"code": "..."
},
{
"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": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 11,
"maximum": 12,
"maximum_day": 10,
"maximum_week": 10
},
"weight": {
"minimum": 18,
"maximum": 11,
"maximum_day": 13,
"maximum_week": 11,
"suggested": 16
},
"persons": {
"minimum": 17,
"maximum": 19
}
},
"id": 14,
"allergens": [
{
"id": 16,
"name": "Milk"
},
{
"id": 12,
"name": "Crustaceans"
},
{
"id": 10,
"name": "Fish"
}
],
"category_id": 18,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Magnam repudiandae quidem quae velit voluptatem enim excepturi enim."
},
"description": {
"en": "Doloribus iste sapiente dolorem eum. Suscipit sequi repellendus libero consequatur dolorem. Qui ducimus dolor est saepe enim."
},
"url": {
"en": "http://www.blanda.info/magni-dolores-autem-sed-delectus-iste-eligendi.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": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 18,
"maximum": 12,
"maximum_day": 10,
"maximum_week": 13
},
"weight": {
"minimum": 10,
"maximum": 14,
"maximum_day": 16,
"maximum_week": 17,
"suggested": 16
},
"persons": {
"minimum": 10,
"maximum": 13
}
},
"id": 19,
"allergens": [
{
"id": 11,
"name": "Soy"
},
{
"id": 17,
"name": "Lactose"
},
{
"id": 10,
"name": "Lactose"
}
],
"category_id": 13,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Ex aut dolore a sunt itaque et consequatur sunt."
},
"description": {
"en": "Quis sit in perspiciatis et. Provident consequatur esse esse consequatur sunt."
},
"url": {
"en": "http://leannon.com/"
}
},
"code": "..."
}
],
"shops": [
{
"name": "Ahmad Sawayn Sr.",
"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": false,
"delivery_use_intervals": 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": true
}
},
{
"name": "Reyna Welch",
"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": 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
}
},
{
"name": "Prof. Robin Monahan Sr.",
"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": 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": 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
}
}
],
"id": 14,
"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": "Vero exercitationem est exercitationem perferendis nihil explicabo."
},
"description": {
"en": "Mollitia perferendis totam ad a nulla. Sint aut sint repudiandae. Suscipit temporibus animi eligendi corporis voluptatem et veritatis."
},
"url": {
"en": "http://tillman.com/eos-eum-dolores-dolor-explicabo-est-ullam-natus.html"
}
}
}