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": "Maurine Veum IV",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"shop_ids": [
18,
10,
17
],
"seo": {
"title": {
"en": "Vel quia sit quos tenetur quidem."
},
"description": {
"en": "Vitae ex perferendis perspiciatis asperiores cum. Quae nam est non optio quod. Officiis dicta voluptatem ea ut minima totam nihil. Doloremque magnam animi eligendi cupiditate quasi dolor."
},
"url": {
"en": "http://www.farrell.com/enim-consequatur-eum-officiis-laudantium-provident-sit-laboriosam-molestiae"
}
},
"product_ids": [
18,
12,
12
]
}When returned in a response.
{
"name": "Dr. Randi Jacobson",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"products": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"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": 11,
"maximum": 15,
"maximum_day": 11,
"maximum_week": 11
},
"weight": {
"minimum": 10,
"maximum": 13,
"maximum_day": 18,
"maximum_week": 11,
"suggested": 12
},
"persons": {
"minimum": 18,
"maximum": 16
}
},
"id": 18,
"allergens": [
{
"id": 14,
"name": "Celery"
},
{
"id": 11,
"name": "Lupine"
},
{
"id": 12,
"name": "Nuts"
}
],
"category_id": 13,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Ipsum porro rem necessitatibus eveniet labore est."
},
"description": {
"en": "Ratione dolorem non qui aut nisi. Distinctio fugit nihil quia voluptas repellat deserunt."
},
"url": {
"en": "http://fritsch.com/eligendi-consequatur-beatae-repellat-ut-praesentium"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 18,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 19,
"maximum": 15,
"maximum_day": 15,
"maximum_week": 14
},
"weight": {
"minimum": 11,
"maximum": 14,
"maximum_day": 10,
"maximum_week": 19,
"suggested": 13
},
"persons": {
"minimum": 14,
"maximum": 19
}
},
"id": 12,
"allergens": [
{
"id": 19,
"name": "Peanut"
},
{
"id": 13,
"name": "Sesame"
},
{
"id": 12,
"name": "Nuts"
}
],
"category_id": 19,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Rem labore ad ut eum pariatur."
},
"description": {
"en": "Porro recusandae eum deserunt labore quas. Sunt ea libero eos. Hic cupiditate dolorem expedita commodi optio."
},
"url": {
"en": "http://www.okeefe.com/"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 18,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 10,
"maximum": 18,
"maximum_day": 14,
"maximum_week": 17
},
"weight": {
"minimum": 14,
"maximum": 14,
"maximum_day": 12,
"maximum_week": 15,
"suggested": 16
},
"persons": {
"minimum": 13,
"maximum": 14
}
},
"id": 15,
"allergens": [
{
"id": 19,
"name": "Sesame"
},
{
"id": 10,
"name": "Mustard"
},
{
"id": 13,
"name": "Lactose"
}
],
"category_id": 10,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Cum molestias iure dolorem voluptas."
},
"description": {
"en": "Quia omnis magni mollitia quibusdam praesentium eius sit. Aut labore est ut quaerat consequatur ut eum."
},
"url": {
"en": "http://dietrich.com/doloribus-et-porro-dicta-et-veniam-incidunt-ea"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
}
],
"shops": [
{
"name": "Mr. Reginald Gerlach PhD",
"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,
"allow_invoices": true,
"allow_order_comments": false,
"allow_product_comments": false,
"takeout_use_intervals": false,
"allow_order_messages": true,
"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": true
}
},
{
"name": "Yessenia Bosco",
"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": false,
"allow_invoices": true,
"allow_order_comments": false,
"allow_product_comments": true,
"takeout_use_intervals": true,
"allow_order_messages": 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": 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": "Nyasia Gorczany",
"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": true,
"delivery_use_intervals": true,
"allow_invoices": false,
"allow_order_comments": false,
"allow_product_comments": false,
"takeout_use_intervals": false,
"allow_order_messages": true,
"id": 16,
"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": 16,
"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 commodi adipisci laborum minus cum qui velit aut autem."
},
"description": {
"en": "Possimus velit consequuntur magnam dolore dolore rerum provident. Rerum minus distinctio odit voluptatem."
},
"url": {
"en": "http://www.douglas.com/beatae-earum-molestiae-sunt"
}
}
}