Fields when send to the api inside a request.
| Field | Type | Description |
|---|---|---|
| id | Int | Id of the category |
| name | String | Translated category name |
| banner | Image? | Nullable. |
| messages | [String] | Array of String |
| products | [Product.detailed] | Array of Product.detailed |
| seo | company.SeoData | Optional. Product page SEO metatags |
Fields when returned by the api in a response.
| Field | Type | Description |
|---|---|---|
| id | Int | Id of the category |
| name | String | Translated category name |
| banner | Image? | Nullable. |
| messages | [String] | Array of String |
| products | [Product.detailed] | Array of Product.detailed |
| seo | company.SeoData | Optional. Product page SEO metatags |
When used inside a request.
{
"id": 11,
"name": "Prof. Jeanne Erdman DVM",
"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
},
"messages": [
"...",
"...",
"..."
],
"products": [
{
"favourite": true
},
{
"favourite": true
},
{
"favourite": false
}
],
"seo": {
"title": {
"en": "Corrupti minima officia animi laboriosam iste mollitia pariatur."
},
"description": {
"en": "Porro cum nemo et molestiae quisquam dignissimos. Qui sequi nemo dolor dicta qui. Sit id consectetur in sit. Sint neque et et ex vel voluptatem delectus. Culpa omnis consequuntur velit ut."
},
"url": {
"en": "http://www.hyatt.com/facere-eveniet-quis-officiis-beatae"
}
}
}When returned in a response.
{
"id": 12,
"name": "Bobbie Friesen",
"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
},
"messages": [
"...",
"...",
"..."
],
"products": [
{
"id": 18,
"name": "...",
"images": [
{
"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
},
{
"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
},
{
"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
}
],
"price_type": "PER_UNIT",
"target_price": false,
"price": {
"value": 18,
"currency": "EUR"
},
"subtitle": "...",
"description": "...",
"allergens": [
{
"id": 17,
"name": "Lactose"
},
{
"id": 10,
"name": "Crustaceans"
},
{
"id": 11,
"name": "Egg"
}
],
"url": "https://example.com",
"url_type": "none",
"specialty": false,
"favourite": false,
"product_prices": [
{
"id": 10,
"name": "...",
"price": {
"value": 12,
"currency": "EUR"
},
"offer": {
"type": "percentage",
"x": 17,
"y": 10,
"percentage": 17,
"minimum": 11,
"offer": {
"id": 15,
"name": "Black Friday"
}
}
},
{
"id": 15,
"name": "...",
"price": {
"value": 11,
"currency": "EUR"
},
"offer": {
"type": "percentage",
"x": 15,
"y": 13,
"percentage": 13,
"minimum": 18,
"offer": {
"id": 11,
"name": "Black Friday"
}
}
},
{
"id": 17,
"name": "...",
"price": {
"value": 14,
"currency": "EUR"
},
"offer": {
"type": "percentage",
"x": 18,
"y": 14,
"percentage": 17,
"minimum": 15,
"offer": {
"id": 13,
"name": "Black Friday"
}
}
}
],
"optionsets": [
{
"id": 17,
"name": "...",
"code": "...",
"options": [
{
"id": 14,
"name": "...",
"price_change": {
"value": 17,
"currency": "EUR"
},
"image": {
"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
},
"require_image": true,
"code": "..."
},
{
"id": 12,
"name": "...",
"price_change": {
"value": 16,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "..."
},
{
"id": 17,
"name": "...",
"price_change": {
"value": 15,
"currency": "EUR"
},
"image": {
"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
},
"require_image": true,
"code": "..."
}
]
},
{
"id": 10,
"name": "...",
"code": "...",
"options": [
{
"id": 13,
"name": "...",
"price_change": {
"value": 14,
"currency": "EUR"
},
"image": {
"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
},
"require_image": true,
"code": "..."
},
{
"id": 11,
"name": "...",
"price_change": {
"value": 12,
"currency": "EUR"
},
"image": {
"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
},
"require_image": true,
"code": "..."
},
{
"id": 17,
"name": "...",
"price_change": {
"value": 12,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "..."
}
]
},
{
"id": 16,
"name": "...",
"code": "...",
"options": [
{
"id": 18,
"name": "...",
"price_change": {
"value": 17,
"currency": "EUR"
},
"image": {
"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
},
"require_image": true,
"code": "..."
},
{
"id": 15,
"name": "...",
"price_change": {
"value": 11,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "..."
},
{
"id": 17,
"name": "...",
"price_change": {
"value": 11,
"currency": "EUR"
},
"image": {
"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
},
"require_image": true,
"code": "..."
}
]
}
],
"min_max": {
"amount": {
"minimum": 10,
"maximum": 11,
"suggested": 17
},
"weight": {
"minimum": 10,
"maximum": 10,
"suggested": 17
},
"persons": {
"minimum": 12,
"maximum": 16,
"suggested": 13
}
},
"info": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
],
"offer": {
"type": "percentage",
"x": 19,
"y": 12,
"percentage": 12,
"minimum": 11,
"offer": {
"id": 18,
"name": "Black Friday"
}
}
},
{
"id": 13,
"name": "...",
"images": [
{
"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
},
{
"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
},
{
"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
}
],
"price_type": "PER_UNIT",
"target_price": false,
"price": {
"value": 14,
"currency": "EUR"
},
"subtitle": "...",
"description": "...",
"allergens": [
{
"id": 11,
"name": "Lupine"
},
{
"id": 13,
"name": "Milk"
},
{
"id": 19,
"name": "Soy"
}
],
"url": "https://example.com",
"url_type": "none",
"specialty": false,
"favourite": true,
"product_prices": [
{
"id": 12,
"name": "...",
"price": {
"value": 19,
"currency": "EUR"
},
"offer": {
"type": "percentage",
"x": 14,
"y": 14,
"percentage": 19,
"minimum": 19,
"offer": {
"id": 15,
"name": "Black Friday"
}
}
},
{
"id": 19,
"name": "...",
"price": {
"value": 11,
"currency": "EUR"
},
"offer": {
"type": "percentage",
"x": 19,
"y": 10,
"percentage": 10,
"minimum": 11,
"offer": {
"id": 12,
"name": "Black Friday"
}
}
},
{
"id": 10,
"name": "...",
"price": {
"value": 12,
"currency": "EUR"
},
"offer": {
"type": "percentage",
"x": 13,
"y": 17,
"percentage": 10,
"minimum": 17,
"offer": {
"id": 14,
"name": "Black Friday"
}
}
}
],
"optionsets": [
{
"id": 19,
"name": "...",
"code": "...",
"options": [
{
"id": 18,
"name": "...",
"price_change": {
"value": 19,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "..."
},
{
"id": 14,
"name": "...",
"price_change": {
"value": 17,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "..."
},
{
"id": 16,
"name": "...",
"price_change": {
"value": 19,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "..."
}
]
},
{
"id": 16,
"name": "...",
"code": "...",
"options": [
{
"id": 10,
"name": "...",
"price_change": {
"value": 18,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "..."
},
{
"id": 19,
"name": "...",
"price_change": {
"value": 11,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "..."
},
{
"id": 19,
"name": "...",
"price_change": {
"value": 17,
"currency": "EUR"
},
"image": {
"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
},
"require_image": true,
"code": "..."
}
]
},
{
"id": 17,
"name": "...",
"code": "...",
"options": [
{
"id": 18,
"name": "...",
"price_change": {
"value": 16,
"currency": "EUR"
},
"image": {
"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
},
"require_image": true,
"code": "..."
},
{
"id": 16,
"name": "...",
"price_change": {
"value": 11,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "..."
},
{
"id": 17,
"name": "...",
"price_change": {
"value": 19,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "..."
}
]
}
],
"min_max": {
"amount": {
"minimum": 19,
"maximum": 14,
"suggested": 11
},
"weight": {
"minimum": 14,
"maximum": 18,
"suggested": 18
},
"persons": {
"minimum": 11,
"maximum": 17,
"suggested": 13
}
},
"info": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
],
"offer": {
"type": "percentage",
"x": 14,
"y": 17,
"percentage": 11,
"minimum": 18,
"offer": {
"id": 18,
"name": "Black Friday"
}
}
},
{
"id": 11,
"name": "...",
"images": [
{
"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
},
{
"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
},
{
"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
}
],
"price_type": "PER_UNIT",
"target_price": false,
"price": {
"value": 14,
"currency": "EUR"
},
"subtitle": "...",
"description": "...",
"allergens": [
{
"id": 11,
"name": "Sesame"
},
{
"id": 18,
"name": "Sesame"
},
{
"id": 10,
"name": "Lactose"
}
],
"url": "https://example.com",
"url_type": "none",
"specialty": true,
"favourite": true,
"product_prices": [
{
"id": 13,
"name": "...",
"price": {
"value": 18,
"currency": "EUR"
},
"offer": {
"type": "percentage",
"x": 16,
"y": 17,
"percentage": 12,
"minimum": 11,
"offer": {
"id": 16,
"name": "Black Friday"
}
}
},
{
"id": 14,
"name": "...",
"price": {
"value": 19,
"currency": "EUR"
},
"offer": {
"type": "percentage",
"x": 12,
"y": 12,
"percentage": 16,
"minimum": 16,
"offer": {
"id": 13,
"name": "Black Friday"
}
}
},
{
"id": 15,
"name": "...",
"price": {
"value": 10,
"currency": "EUR"
},
"offer": {
"type": "percentage",
"x": 12,
"y": 15,
"percentage": 18,
"minimum": 16,
"offer": {
"id": 19,
"name": "Black Friday"
}
}
}
],
"optionsets": [
{
"id": 12,
"name": "...",
"code": "...",
"options": [
{
"id": 16,
"name": "...",
"price_change": {
"value": 18,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "..."
},
{
"id": 16,
"name": "...",
"price_change": {
"value": 10,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "..."
},
{
"id": 10,
"name": "...",
"price_change": {
"value": 18,
"currency": "EUR"
},
"image": {
"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
},
"require_image": true,
"code": "..."
}
]
},
{
"id": 19,
"name": "...",
"code": "...",
"options": [
{
"id": 10,
"name": "...",
"price_change": {
"value": 15,
"currency": "EUR"
},
"image": {
"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
},
"require_image": true,
"code": "..."
},
{
"id": 15,
"name": "...",
"price_change": {
"value": 13,
"currency": "EUR"
},
"image": {
"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
},
"require_image": true,
"code": "..."
},
{
"id": 11,
"name": "...",
"price_change": {
"value": 11,
"currency": "EUR"
},
"image": {
"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
},
"require_image": true,
"code": "..."
}
]
},
{
"id": 10,
"name": "...",
"code": "...",
"options": [
{
"id": 11,
"name": "...",
"price_change": {
"value": 14,
"currency": "EUR"
},
"image": {
"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
},
"require_image": true,
"code": "..."
},
{
"id": 16,
"name": "...",
"price_change": {
"value": 18,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "..."
},
{
"id": 11,
"name": "...",
"price_change": {
"value": 12,
"currency": "EUR"
},
"image": {
"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
},
"require_image": false,
"code": "..."
}
]
}
],
"min_max": {
"amount": {
"minimum": 14,
"maximum": 11,
"suggested": 13
},
"weight": {
"minimum": 15,
"maximum": 18,
"suggested": 15
},
"persons": {
"minimum": 15,
"maximum": 12,
"suggested": 10
}
},
"info": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
],
"offer": {
"type": "percentage",
"x": 16,
"y": 15,
"percentage": 19,
"minimum": 10,
"offer": {
"id": 12,
"name": "Black Friday"
}
}
}
],
"seo": {
"title": {
"en": "Voluptas consequatur delectus qui officia et perferendis eaque."
},
"description": {
"en": "Consequatur accusamus voluptate necessitatibus assumenda natus. Non facere molestiae harum exercitationem aut. Velit ut dolorem autem sit. Consequatur consequatur dolore ullam laboriosam natus."
},
"url": {
"en": "http://koelpin.org/"
}
}
}