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": "Ambrose Hilpert",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"shop_ids": [
14,
10,
14
],
"seo": {
"title": {
"en": "Ullam dicta et repudiandae molestiae eum excepturi."
},
"description": {
"en": "Distinctio facilis eum ipsum ea esse dicta. Nihil esse qui et. Et perferendis magni nisi suscipit at omnis aut voluptatem. Perspiciatis tenetur quas quos eum."
},
"url": {
"en": "http://www.keeling.com/"
}
},
"product_ids": [
11,
16,
19
]
}When returned in a response.
{
"name": "Howell Dach",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"products": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 19,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 19,
"maximum": 10,
"maximum_day": 17,
"maximum_week": 13
},
"weight": {
"minimum": 17,
"maximum": 14,
"maximum_day": 14,
"maximum_week": 18,
"suggested": 17
},
"persons": {
"minimum": 18,
"maximum": 15
}
},
"id": 16,
"allergens": [
{
"id": 11,
"name": "Sulphite"
},
{
"id": 13,
"name": "Sesame"
},
{
"id": 18,
"name": "Mollusc"
}
],
"category_id": 15,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Eveniet quis omnis et quia in dolor."
},
"description": {
"en": "Dicta qui reiciendis nihil adipisci provident corrupti qui optio. Sed pariatur iusto fuga. Sed voluptate suscipit error distinctio aliquid enim."
},
"url": {
"en": "https://www.hessel.com/laboriosam-enim-recusandae-est-nobis"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"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": 15,
"maximum": 18,
"maximum_day": 11,
"maximum_week": 19
},
"weight": {
"minimum": 11,
"maximum": 13,
"maximum_day": 16,
"maximum_week": 16,
"suggested": 18
},
"persons": {
"minimum": 17,
"maximum": 19
}
},
"id": 17,
"allergens": [
{
"id": 19,
"name": "Soy"
},
{
"id": 15,
"name": "Gluten"
},
{
"id": 19,
"name": "Crustaceans"
}
],
"category_id": 16,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Velit ea provident est illo quaerat ducimus ipsam."
},
"description": {
"en": "Voluptate saepe laudantium non perspiciatis fugit eius. Culpa quaerat quis quam ab et vitae non. Eveniet libero itaque aut et quia. Qui corporis necessitatibus cum tempora fuga mollitia totam."
},
"url": {
"en": "http://www.flatley.com/aspernatur-ullam-quidem-nihil-voluptas-eos"
}
},
"code": "..."
},
{
"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": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 18,
"maximum": 13,
"maximum_day": 15,
"maximum_week": 18
},
"weight": {
"minimum": 19,
"maximum": 11,
"maximum_day": 19,
"maximum_week": 13,
"suggested": 18
},
"persons": {
"minimum": 18,
"maximum": 16
}
},
"id": 12,
"allergens": [
{
"id": 16,
"name": "Lupine"
},
{
"id": 11,
"name": "Sesame"
},
{
"id": 16,
"name": "Soy"
}
],
"category_id": 17,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Accusantium laboriosam aut ut nemo in sunt esse illo."
},
"description": {
"en": "Quasi laboriosam dicta cumque nesciunt maxime. Sint commodi incidunt nihil explicabo."
},
"url": {
"en": "http://brown.org/"
}
},
"code": "..."
}
],
"shops": [
{
"name": "Katelin Cronin",
"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": false,
"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": "Selmer Willms",
"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,
"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": 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": "Karlie Lowe",
"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
}
}
],
"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": "Facere tenetur laudantium eveniet ut et possimus ut."
},
"description": {
"en": "Et odio in ea ipsa et est. Tempora necessitatibus nam rerum sequi alias officia tempore ipsa. Doloribus itaque sint rerum voluptatem est."
},
"url": {
"en": "http://kessler.com/"
}
}
}