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": "Mr. Oran Hudson",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"shop_ids": [
18,
10,
15
],
"seo": {
"title": {
"en": "Consequatur excepturi rerum ad recusandae nemo eum minima id."
},
"description": {
"en": "Ut dicta velit reiciendis est aut. Laboriosam eaque autem qui ipsam laboriosam fugit. Itaque placeat corrupti impedit doloribus. Autem explicabo est quis eos esse."
},
"url": {
"en": "http://heller.com/saepe-velit-est-adipisci-nesciunt.html"
}
},
"product_ids": [
14,
18,
12
]
}When returned in a response.
{
"name": "Cleta Adams I",
"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": 12,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 15,
"maximum": 16,
"maximum_day": 16,
"maximum_week": 11
},
"weight": {
"minimum": 17,
"maximum": 14,
"maximum_day": 10,
"maximum_week": 10,
"suggested": 19
},
"persons": {
"minimum": 15,
"maximum": 14
}
},
"id": 14,
"allergens": [
{
"id": 18,
"name": "Sulphite"
},
{
"id": 16,
"name": "Peanut"
},
{
"id": 12,
"name": "Celery"
}
],
"category_id": 14,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Corporis eveniet facilis id id possimus non."
},
"description": {
"en": "Maiores animi consequuntur qui hic est tempora. Quis eius perspiciatis reprehenderit consequatur sed eaque repellendus quo. Alias molestias quia distinctio provident veniam ratione aspernatur."
},
"url": {
"en": "http://www.kris.com/"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 15,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 17,
"maximum": 19,
"maximum_day": 13,
"maximum_week": 11
},
"weight": {
"minimum": 18,
"maximum": 17,
"maximum_day": 17,
"maximum_week": 19,
"suggested": 10
},
"persons": {
"minimum": 10,
"maximum": 12
}
},
"id": 15,
"allergens": [
{
"id": 16,
"name": "Gluten"
},
{
"id": 11,
"name": "Sulphite"
},
{
"id": 14,
"name": "Nuts"
}
],
"category_id": 14,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Debitis numquam nobis asperiores dolorem fugiat asperiores."
},
"description": {
"en": "Aspernatur quis quis consequuntur sequi laboriosam. Non dolorem laudantium alias. Illo doloribus et perspiciatis qui cum aliquam nisi. Unde officiis hic quia velit."
},
"url": {
"en": "http://www.hegmann.com/"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 12,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 16,
"maximum": 11,
"maximum_day": 12,
"maximum_week": 11
},
"weight": {
"minimum": 17,
"maximum": 19,
"maximum_day": 17,
"maximum_week": 14,
"suggested": 14
},
"persons": {
"minimum": 19,
"maximum": 19
}
},
"id": 13,
"allergens": [
{
"id": 18,
"name": "Mustard"
},
{
"id": 14,
"name": "Lactose"
},
{
"id": 11,
"name": "Crustaceans"
}
],
"category_id": 16,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Aut voluptatem quia sed similique cumque molestiae deserunt facilis esse quam."
},
"description": {
"en": "Deserunt assumenda tempora corrupti similique. Sed amet perspiciatis nostrum et laudantium aut. Rerum voluptatem est voluptatem fugiat."
},
"url": {
"en": "http://www.heathcote.com/"
}
},
"code": "..."
}
],
"shops": [
{
"name": "Noemy Bashirian",
"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,
"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": "Sallie Rempel",
"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": 18,
"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": "Dr. Devonte Boyer DDS",
"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": 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": 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": 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": true
},
"seo": {
"title": {
"en": "Amet animi illum inventore in commodi quia inventore."
},
"description": {
"en": "Doloribus laudantium qui et velit voluptatum deserunt nemo. Accusantium inventore vel consequatur non aut similique illo."
},
"url": {
"en": "http://rowe.net/voluptate-eos-dolore-omnis-in-iusto.html"
}
}
}