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": 19,
"name": "Dr. Mohammed Romaguera 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": false
},
"messages": [
"...",
"...",
"..."
],
"products": [
{
"favourite": false
},
{
"favourite": true
},
{
"favourite": false
}
],
"seo": {
"title": {
"en": "Ut saepe soluta odit odit numquam voluptatum aut ad enim."
},
"description": {
"en": "Consequatur architecto natus rerum fuga quaerat vel repudiandae. Nisi et est tempora vero eum voluptatem labore. Ut asperiores quos unde vitae perferendis sit."
},
"url": {
"en": "http://www.hegmann.org/rerum-laboriosam-error-quae-qui-suscipit.html"
}
}
}When returned in a response.
{
"id": 14,
"name": "Ahmad Larkin V",
"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": 14,
"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": 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": 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": 11,
"subtitle": "...",
"description": "...",
"allergens": [
{
"id": 14,
"name": "Crustaceans"
},
{
"id": 12,
"name": "Sesame"
},
{
"id": 12,
"name": "Peanut"
}
],
"url": "https://example.com",
"url_type": "none",
"specialty": true,
"favourite": true,
"product_prices": [
{
"id": 10,
"name": "...",
"price": 18
},
{
"id": 18,
"name": "...",
"price": 11
},
{
"id": 10,
"name": "...",
"price": 12
}
],
"optionsets": [
{
"id": 19,
"name": "...",
"allow_attachment": false,
"options": [
{
"id": 19,
"name": "...",
"price_change": 12
},
{
"id": 11,
"name": "...",
"price_change": 18
},
{
"id": 12,
"name": "...",
"price_change": 15
}
]
},
{
"id": 14,
"name": "...",
"allow_attachment": true,
"options": [
{
"id": 10,
"name": "...",
"price_change": 13
},
{
"id": 18,
"name": "...",
"price_change": 10
},
{
"id": 13,
"name": "...",
"price_change": 12
}
]
},
{
"id": 13,
"name": "...",
"allow_attachment": false,
"options": [
{
"id": 14,
"name": "...",
"price_change": 12
},
{
"id": 17,
"name": "...",
"price_change": 17
},
{
"id": 13,
"name": "...",
"price_change": 10
}
]
}
],
"min_max": {
"amount": {
"minimum": 14,
"maximum": 15,
"suggested": 11
},
"weight": {
"minimum": 14,
"maximum": 17,
"suggested": 11
},
"persons": {
"minimum": 18,
"maximum": 17,
"suggested": 17
}
},
"info": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
]
},
{
"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": 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": true,
"price": 16,
"subtitle": "...",
"description": "...",
"allergens": [
{
"id": 19,
"name": "Sulphite"
},
{
"id": 19,
"name": "Fish"
},
{
"id": 16,
"name": "Mustard"
}
],
"url": "https://example.com",
"url_type": "none",
"specialty": true,
"favourite": true,
"product_prices": [
{
"id": 13,
"name": "...",
"price": 18
},
{
"id": 10,
"name": "...",
"price": 18
},
{
"id": 19,
"name": "...",
"price": 11
}
],
"optionsets": [
{
"id": 17,
"name": "...",
"allow_attachment": false,
"options": [
{
"id": 12,
"name": "...",
"price_change": 15
},
{
"id": 12,
"name": "...",
"price_change": 13
},
{
"id": 17,
"name": "...",
"price_change": 13
}
]
},
{
"id": 12,
"name": "...",
"allow_attachment": false,
"options": [
{
"id": 10,
"name": "...",
"price_change": 13
},
{
"id": 13,
"name": "...",
"price_change": 19
},
{
"id": 18,
"name": "...",
"price_change": 17
}
]
},
{
"id": 15,
"name": "...",
"allow_attachment": false,
"options": [
{
"id": 11,
"name": "...",
"price_change": 19
},
{
"id": 13,
"name": "...",
"price_change": 13
},
{
"id": 18,
"name": "...",
"price_change": 10
}
]
}
],
"min_max": {
"amount": {
"minimum": 10,
"maximum": 10,
"suggested": 16
},
"weight": {
"minimum": 19,
"maximum": 16,
"suggested": 14
},
"persons": {
"minimum": 11,
"maximum": 12,
"suggested": 12
}
},
"info": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
]
},
{
"id": 12,
"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": 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": 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": 10,
"subtitle": "...",
"description": "...",
"allergens": [
{
"id": 18,
"name": "Crustaceans"
},
{
"id": 18,
"name": "Lupine"
},
{
"id": 13,
"name": "Sulphite"
}
],
"url": "https://example.com",
"url_type": "none",
"specialty": true,
"favourite": false,
"product_prices": [
{
"id": 17,
"name": "...",
"price": 18
},
{
"id": 17,
"name": "...",
"price": 10
},
{
"id": 15,
"name": "...",
"price": 18
}
],
"optionsets": [
{
"id": 14,
"name": "...",
"allow_attachment": true,
"options": [
{
"id": 18,
"name": "...",
"price_change": 19
},
{
"id": 15,
"name": "...",
"price_change": 15
},
{
"id": 13,
"name": "...",
"price_change": 17
}
]
},
{
"id": 14,
"name": "...",
"allow_attachment": false,
"options": [
{
"id": 17,
"name": "...",
"price_change": 12
},
{
"id": 18,
"name": "...",
"price_change": 19
},
{
"id": 14,
"name": "...",
"price_change": 17
}
]
},
{
"id": 11,
"name": "...",
"allow_attachment": false,
"options": [
{
"id": 10,
"name": "...",
"price_change": 10
},
{
"id": 16,
"name": "...",
"price_change": 15
},
{
"id": 14,
"name": "...",
"price_change": 17
}
]
}
],
"min_max": {
"amount": {
"minimum": 12,
"maximum": 15,
"suggested": 18
},
"weight": {
"minimum": 14,
"maximum": 13,
"suggested": 15
},
"persons": {
"minimum": 17,
"maximum": 12,
"suggested": 10
}
},
"info": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
]
}
],
"seo": {
"title": {
"en": "Nisi consequatur rerum vero consequatur corrupti occaecati in officia."
},
"description": {
"en": "Consequatur velit impedit deleniti. Expedita ut tempora quibusdam neque distinctio aspernatur. Labore voluptatem est sapiente quo quibusdam. Cupiditate earum beatae error ipsa."
},
"url": {
"en": "http://marquardt.com/minus-est-velit-quidem-doloribus-voluptates.html"
}
}
}