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 |
| seo | company.SeoData | Optional. The category's webpage search engine metatags |
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": "Rocio Carroll",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"seo": {
"title": {
"en": "Sint ad at at sed quae nulla reprehenderit magni beatae fuga."
},
"description": {
"en": "Ut autem odit illo et. Quisquam ea sequi cumque rerum. Eius maxime et voluptas est."
},
"url": {
"en": "https://doyle.com/non-ipsam-in-laudantium-eos.html"
}
}
}When returned in a response.
{
"name": "Dr. Frida Harber II",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"products": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 10,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 12,
"maximum": 10,
"maximum_day": 12,
"maximum_week": 13
},
"weight": {
"minimum": 15,
"maximum": 13,
"maximum_day": 16,
"maximum_week": 18,
"suggested": 15
},
"persons": {
"minimum": 10,
"maximum": 10
}
},
"id": 19,
"allergens": [
{
"id": 11,
"name": "Soy"
},
{
"id": 15,
"name": "Sulphite"
},
{
"id": 15,
"name": "Gluten"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Ratione doloribus totam vero est dolores."
},
"description": {
"en": "Voluptatem unde quos at incidunt fugit inventore. Possimus maiores dicta illum mollitia quis. Ipsam eius voluptatum saepe a."
},
"url": {
"en": "http://graham.org/expedita-exercitationem-id-autem-laboriosam-aut-vel"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 18,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 10,
"maximum": 19,
"maximum_day": 17,
"maximum_week": 16
},
"weight": {
"minimum": 18,
"maximum": 14,
"maximum_day": 11,
"maximum_week": 19,
"suggested": 16
},
"persons": {
"minimum": 13,
"maximum": 15
}
},
"id": 15,
"allergens": [
{
"id": 14,
"name": "Celery"
},
{
"id": 10,
"name": "Nuts"
},
{
"id": 18,
"name": "Egg"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Sit reiciendis debitis sunt quaerat in tempore ut accusantium autem minima."
},
"description": {
"en": "Recusandae consequatur omnis numquam quas voluptates eum et. Qui aut ut tenetur modi voluptas. Sit deleniti et ut."
},
"url": {
"en": "http://goyette.biz/corrupti-sed-explicabo-doloremque-eum-neque-et-quidem.html"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 16,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 16,
"maximum": 18,
"maximum_day": 18,
"maximum_week": 14
},
"weight": {
"minimum": 11,
"maximum": 17,
"maximum_day": 11,
"maximum_week": 14,
"suggested": 17
},
"persons": {
"minimum": 15,
"maximum": 12
}
},
"id": 19,
"allergens": [
{
"id": 16,
"name": "Peanut"
},
{
"id": 18,
"name": "Crustaceans"
},
{
"id": 14,
"name": "Sulphite"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Recusandae odit dignissimos corporis corrupti dicta."
},
"description": {
"en": "Ea quae ad deserunt nemo incidunt. Odio omnis natus explicabo cupiditate eos nemo. Quaerat porro cum optio."
},
"url": {
"en": "https://www.renner.com/nostrum-hic-itaque-sunt-incidunt-est-facilis-maiores-nihil"
}
}
}
],
"shops": [
{
"name": "Orie Bode",
"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": 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": 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": "Jessyca Gibson",
"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": 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": "Hardy Dach",
"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": 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": 11,
"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": "Omnis quisquam natus recusandae deserunt consequatur pariatur consequatur."
},
"description": {
"en": "Et et qui aut delectus provident. Architecto in ab et deserunt iusto veniam."
},
"url": {
"en": "http://bailey.net/dignissimos-magni-laudantium-eaque-qui-consequatur-enim-libero.html"
}
}
}