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": "Doug Harvey",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"shop_ids": [
12,
13,
11
],
"seo": {
"title": {
"en": "Amet minus fuga sunt ea harum praesentium sed."
},
"description": {
"en": "Qui doloremque in et iure quae. Sunt quia unde nobis cum ipsam ullam. Eos illum hic sed et voluptate rerum magni."
},
"url": {
"en": "http://kemmer.com/qui-non-accusantium-et-tenetur"
}
},
"product_ids": [
16,
19,
12
]
}When returned in a response.
{
"name": "Melany Raynor",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"products": [
{
"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": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 17,
"maximum": 10,
"maximum_day": 19,
"maximum_week": 10
},
"weight": {
"minimum": 15,
"maximum": 12,
"maximum_day": 10,
"maximum_week": 10,
"suggested": 11
},
"persons": {
"minimum": 13,
"maximum": 14
}
},
"id": 16,
"allergens": [
{
"id": 15,
"name": "Fish"
},
{
"id": 10,
"name": "Soy"
},
{
"id": 16,
"name": "Nuts"
}
],
"category_id": 16,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Vel omnis nesciunt nemo minus cupiditate incidunt id."
},
"description": {
"en": "At consequatur rerum ut cupiditate. Nesciunt non exercitationem unde sapiente quos voluptas. Rerum inventore quaerat voluptas quasi. Tempore placeat rerum sapiente."
},
"url": {
"en": "http://www.leffler.biz/molestiae-quis-iste-fugit-soluta-dicta-sequi.html"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 19,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 10,
"maximum": 11,
"maximum_day": 19,
"maximum_week": 16
},
"weight": {
"minimum": 16,
"maximum": 15,
"maximum_day": 14,
"maximum_week": 12,
"suggested": 17
},
"persons": {
"minimum": 18,
"maximum": 16
}
},
"id": 16,
"allergens": [
{
"id": 10,
"name": "Mollusc"
},
{
"id": 16,
"name": "Soy"
},
{
"id": 19,
"name": "Celery"
}
],
"category_id": 18,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Qui saepe est repellendus quia officiis doloremque."
},
"description": {
"en": "Incidunt nesciunt dolorem nulla aut iusto quae in. Id sed saepe voluptatem. Non numquam natus repellat ut provident impedit minus accusamus. Officia in doloribus ut aut quidem."
},
"url": {
"en": "http://www.bradtke.com/praesentium-tenetur-sed-qui-nihil"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 17,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 14,
"maximum": 14,
"maximum_day": 13,
"maximum_week": 19
},
"weight": {
"minimum": 11,
"maximum": 12,
"maximum_day": 14,
"maximum_week": 18,
"suggested": 19
},
"persons": {
"minimum": 13,
"maximum": 13
}
},
"id": 19,
"allergens": [
{
"id": 18,
"name": "Celery"
},
{
"id": 18,
"name": "Crustaceans"
},
{
"id": 16,
"name": "Soy"
}
],
"category_id": 13,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Ea odit molestias libero quidem quasi architecto consequuntur repellat ipsa similique."
},
"description": {
"en": "Sit aspernatur illo ullam vel eveniet et nihil corporis. Illum mollitia saepe vitae quia aut sed autem tenetur. Necessitatibus aut sit placeat maiores eum odio."
},
"url": {
"en": "http://www.olson.biz/incidunt-id-nisi-facilis-laudantium.html"
}
},
"code": "..."
}
],
"shops": [
{
"name": "Jake Beahan",
"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,
"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": false
}
},
{
"name": "Danial Lubowitz",
"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": 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": true
}
},
{
"name": "Ophelia Runolfsdottir",
"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": 10,
"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
}
}
],
"id": 12,
"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": "Unde hic temporibus ratione odit consequatur molestias unde a necessitatibus et."
},
"description": {
"en": "Et sequi debitis corporis saepe voluptatem. Fuga nulla aut saepe vitae optio. Deserunt deleniti repellat perspiciatis. Aliquam quia voluptatem voluptatem laborum ipsam."
},
"url": {
"en": "http://altenwerth.com/"
}
}
}