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": "Miss Velva Steuber Jr.",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"shop_ids": [
19,
16,
14
],
"seo": {
"title": {
"en": "Aut reiciendis natus voluptatem voluptatum sit corporis deserunt quisquam voluptate officia deleniti."
},
"description": {
"en": "Est sit dolore magni eius. Beatae est quas eum. Deserunt cupiditate facere eaque quos accusantium."
},
"url": {
"en": "https://www.green.com/dolor-beatae-ducimus-molestiae-dolorem-sed"
}
},
"product_ids": [
14,
11,
17
]
}When returned in a response.
{
"name": "Michele Paucek DVM",
"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": true,
"price_type": "PER_UNIT",
"price": 17,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 13,
"maximum": 16,
"maximum_day": 15,
"maximum_week": 13
},
"weight": {
"minimum": 13,
"maximum": 15,
"maximum_day": 14,
"maximum_week": 11,
"suggested": 13
},
"persons": {
"minimum": 18,
"maximum": 10
}
},
"id": 15,
"allergens": [
{
"id": 19,
"name": "Soy"
},
{
"id": 11,
"name": "Celery"
},
{
"id": 13,
"name": "Egg"
}
],
"category_id": 15,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Deserunt eum quod labore blanditiis magnam impedit consectetur facere."
},
"description": {
"en": "Illum quo blanditiis aut error voluptate expedita. Qui reiciendis delectus quo voluptatibus rerum asperiores. Dolorem est repudiandae nihil."
},
"url": {
"en": "http://www.wunsch.info/"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 13,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 10,
"maximum": 14,
"maximum_day": 11,
"maximum_week": 14
},
"weight": {
"minimum": 15,
"maximum": 18,
"maximum_day": 13,
"maximum_week": 16,
"suggested": 16
},
"persons": {
"minimum": 15,
"maximum": 13
}
},
"id": 17,
"allergens": [
{
"id": 17,
"name": "Soy"
},
{
"id": 15,
"name": "Lupine"
},
{
"id": 13,
"name": "Lactose"
}
],
"category_id": 14,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Eveniet facere reiciendis est dolorem temporibus sed in harum repellat sed."
},
"description": {
"en": "Odit tenetur non ea voluptates dolor. Culpa numquam nihil nemo adipisci et est. Nobis culpa nemo repellendus ipsa. Aperiam amet ipsa quia architecto. Quia autem beatae incidunt non."
},
"url": {
"en": "http://emmerich.net/nemo-aut-odit-sint-fuga-provident-facilis"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 14,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 15,
"maximum": 16,
"maximum_day": 14,
"maximum_week": 19
},
"weight": {
"minimum": 10,
"maximum": 18,
"maximum_day": 14,
"maximum_week": 13,
"suggested": 13
},
"persons": {
"minimum": 16,
"maximum": 12
}
},
"id": 10,
"allergens": [
{
"id": 15,
"name": "Fish"
},
{
"id": 17,
"name": "Egg"
},
{
"id": 15,
"name": "Soy"
}
],
"category_id": 15,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Eos sed doloremque officiis aut rerum omnis explicabo."
},
"description": {
"en": "Neque aut quia error soluta iure architecto. Perspiciatis iste perspiciatis quae dolores dolor. Corrupti ut et est illo quidem amet voluptas."
},
"url": {
"en": "http://www.lindgren.net/voluptas-dolores-enim-saepe-nihil-quaerat"
}
}
}
],
"shops": [
{
"name": "Amir Bogan",
"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,
"allow_invoices": 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": false
}
},
{
"name": "Jevon Corwin",
"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": false,
"allow_invoices": 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": 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": "Kayley Trantow",
"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": false,
"delivery_use_intervals": false,
"allow_invoices": false,
"id": 15,
"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": 14,
"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": "Beatae voluptate amet laborum ullam voluptatum perferendis at."
},
"description": {
"en": "Accusamus pariatur cupiditate dolorem aut libero. Assumenda nostrum quia exercitationem nemo eius optio. Reiciendis at voluptas et asperiores praesentium aut nobis."
},
"url": {
"en": "http://stokes.org/"
}
}
}