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": "Antonio Gottlieb",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"shop_ids": [
15,
18,
14
],
"seo": {
"title": {
"en": "Consequatur distinctio sapiente dolorem voluptas ut non incidunt."
},
"description": {
"en": "Expedita suscipit cum quod quo saepe sit. Cumque sunt ratione libero provident. Quia fugit autem velit quam."
},
"url": {
"en": "http://www.fay.net/esse-omnis-explicabo-nemo-ea-dolore.html"
}
},
"product_ids": [
19,
18,
11
]
}When returned in a response.
{
"name": "Lavonne McLaughlin",
"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": false,
"price_type": "PER_UNIT",
"price": 19,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 11,
"maximum": 16,
"maximum_day": 15,
"maximum_week": 19
},
"weight": {
"minimum": 13,
"maximum": 12,
"maximum_day": 16,
"maximum_week": 12,
"suggested": 13
},
"persons": {
"minimum": 11,
"maximum": 17
}
},
"id": 15,
"allergens": [
{
"id": 14,
"name": "Sulphite"
},
{
"id": 10,
"name": "Sesame"
},
{
"id": 10,
"name": "Egg"
}
],
"category_id": 12,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Aliquam ab excepturi quis distinctio temporibus numquam ducimus."
},
"description": {
"en": "Et odio dolor aliquid. Non omnis reprehenderit iste et dolore. Beatae eum magni recusandae quos voluptatem tempora consectetur."
},
"url": {
"en": "http://www.walsh.com/"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 16,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 18,
"maximum": 11,
"maximum_day": 18,
"maximum_week": 17
},
"weight": {
"minimum": 12,
"maximum": 16,
"maximum_day": 10,
"maximum_week": 12,
"suggested": 18
},
"persons": {
"minimum": 16,
"maximum": 15
}
},
"id": 13,
"allergens": [
{
"id": 15,
"name": "Sulphite"
},
{
"id": 18,
"name": "Lactose"
},
{
"id": 14,
"name": "Fish"
}
],
"category_id": 12,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Ad et porro sint reiciendis eum ad."
},
"description": {
"en": "Vel non fugit dicta. Aliquid repudiandae aliquid odit consequatur voluptate omnis. Perspiciatis magni incidunt non quidem nihil velit aspernatur."
},
"url": {
"en": "http://www.bartell.biz/reiciendis-tenetur-delectus-quis-sunt-itaque.html"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"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": 13,
"maximum": 16,
"maximum_day": 16,
"maximum_week": 15
},
"weight": {
"minimum": 10,
"maximum": 11,
"maximum_day": 11,
"maximum_week": 15,
"suggested": 13
},
"persons": {
"minimum": 19,
"maximum": 17
}
},
"id": 17,
"allergens": [
{
"id": 12,
"name": "Mustard"
},
{
"id": 16,
"name": "Fish"
},
{
"id": 18,
"name": "Sulphite"
}
],
"category_id": 13,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Neque illum dolor voluptatibus itaque eius occaecati esse provident."
},
"description": {
"en": "Officiis non quaerat alias voluptatem. Et dolorem est atque sint magnam. Ad exercitationem non rerum eos."
},
"url": {
"en": "http://senger.net/dolore-quisquam-ratione-sit"
}
},
"code": "..."
}
],
"shops": [
{
"name": "Lawson Brown",
"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": 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": 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
}
},
{
"name": "Evans Olson",
"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": 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
}
},
{
"name": "Mr. Jayson Stark",
"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": 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": true
}
}
],
"id": 13,
"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": "Maxime quidem et placeat ut atque neque magnam vel."
},
"description": {
"en": "Praesentium nihil earum recusandae ratione rerum optio dolorem harum. Quis deleniti fugiat quo incidunt quaerat laudantium. Id hic totam nemo placeat corrupti ratione veritatis sunt."
},
"url": {
"en": "https://hamill.com/nam-quod-rem-quos-consectetur-animi.html"
}
}
}