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": "Charlotte Nikolaus DDS",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"shop_ids": [
17,
18,
11
],
"seo": {
"title": {
"en": "Iure dolorum at minus officiis minus consequatur."
},
"description": {
"en": "Similique labore ut ut quas quaerat optio iste cupiditate. Quis dolor exercitationem et voluptatibus vero doloremque. Harum numquam dolores ut commodi. Mollitia harum voluptatem sint et."
},
"url": {
"en": "http://www.kovacek.com/"
}
},
"product_ids": [
10,
13,
11
]
}When returned in a response.
{
"name": "Ms. Annetta Towne",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"products": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 11,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 12,
"maximum": 16,
"maximum_day": 19,
"maximum_week": 11
},
"weight": {
"minimum": 11,
"maximum": 19,
"maximum_day": 16,
"maximum_week": 10,
"suggested": 11
},
"persons": {
"minimum": 11,
"maximum": 11
}
},
"id": 19,
"allergens": [
{
"id": 18,
"name": "Soy"
},
{
"id": 10,
"name": "Soy"
},
{
"id": 15,
"name": "Lactose"
}
],
"category_id": 17,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Est aut earum in rem mollitia a similique ad dignissimos."
},
"description": {
"en": "Voluptatem dolorum qui quo delectus voluptas velit. Quam quia expedita occaecati eaque impedit. Perferendis minima harum dolor omnis pariatur voluptatem porro. Aliquam omnis et voluptas debitis."
},
"url": {
"en": "http://langosh.com/sed-distinctio-quo-minima-perferendis-fugiat.html"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 11,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 12,
"maximum": 10,
"maximum_day": 12,
"maximum_week": 10
},
"weight": {
"minimum": 10,
"maximum": 17,
"maximum_day": 13,
"maximum_week": 11,
"suggested": 19
},
"persons": {
"minimum": 14,
"maximum": 18
}
},
"id": 16,
"allergens": [
{
"id": 16,
"name": "Milk"
},
{
"id": 14,
"name": "Egg"
},
{
"id": 11,
"name": "Mustard"
}
],
"category_id": 15,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Molestiae animi suscipit assumenda optio facilis."
},
"description": {
"en": "Qui illo ut quia et inventore. Doloremque et illo aperiam facilis quos ut maiores. Accusantium ut velit velit qui earum autem saepe ex. Nesciunt rerum fugit ipsam nam at nisi."
},
"url": {
"en": "http://www.hand.com/consequatur-incidunt-quo-perferendis-libero.html"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 10,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 10,
"maximum": 13,
"maximum_day": 16,
"maximum_week": 12
},
"weight": {
"minimum": 14,
"maximum": 11,
"maximum_day": 10,
"maximum_week": 17,
"suggested": 12
},
"persons": {
"minimum": 16,
"maximum": 17
}
},
"id": 14,
"allergens": [
{
"id": 17,
"name": "Fish"
},
{
"id": 15,
"name": "Celery"
},
{
"id": 11,
"name": "Milk"
}
],
"category_id": 16,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Ab veritatis qui eos ut porro quia veniam quisquam cumque."
},
"description": {
"en": "Quo quaerat possimus eius nihil non doloremque in. Ab id et voluptatem. Asperiores nisi odit debitis quos sit qui autem. Rerum at nihil saepe id reiciendis consequuntur nihil quo."
},
"url": {
"en": "https://www.legros.org/quis-beatae-quaerat-quia-aut-vitae-qui-quaerat"
}
}
}
],
"shops": [
{
"name": "Aurelia Williamson",
"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": true,
"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": "Lester Streich",
"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": 17,
"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": "Prof. Jerel Monahan Sr.",
"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": 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": 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": false
},
"seo": {
"title": {
"en": "Odit cum ad ea facilis consequuntur ut deserunt dolorem omnis tempora."
},
"description": {
"en": "Beatae qui deleniti et temporibus illo est. Placeat ipsam et quis sint aut et ratione. Et voluptatibus maiores est non aut."
},
"url": {
"en": "http://www.boehm.com/velit-deleniti-repellat-magnam-aut-suscipit-perferendis-possimus"
}
}
}