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": "Mr. Zechariah Raynor DDS",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"seo": {
"title": {
"en": "Repudiandae dolor beatae praesentium rem voluptatem esse pariatur."
},
"description": {
"en": "Quod beatae maiores ut facere aspernatur. Voluptate ut totam aspernatur rerum. Est nihil magnam nemo illum ex libero fugiat saepe. Eius sapiente culpa impedit natus sapiente."
},
"url": {
"en": "http://www.carter.net/optio-quisquam-suscipit-quisquam-quia"
}
}
}When returned in a response.
{
"name": "Mr. Louvenia Treutel",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"products": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 19,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 14,
"maximum": 14,
"maximum_day": 19,
"maximum_week": 10
},
"weight": {
"minimum": 12,
"maximum": 18,
"maximum_day": 16,
"maximum_week": 18,
"suggested": 19
},
"persons": {
"minimum": 18,
"maximum": 16
}
},
"id": 16,
"allergens": [
{
"id": 17,
"name": "Peanut"
},
{
"id": 15,
"name": "Crustaceans"
},
{
"id": 11,
"name": "Soy"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Repudiandae eos voluptas itaque aut saepe doloremque iure repellendus ut ut."
},
"description": {
"en": "Omnis maxime vel enim dicta. Est ut aut nam deleniti rerum possimus omnis et. Animi impedit vel ea enim nesciunt. Voluptatem voluptas quisquam dolorum."
},
"url": {
"en": "https://www.hills.info/neque-odit-labore-sed-expedita-ut"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 13,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 12,
"maximum": 14,
"maximum_day": 18,
"maximum_week": 18
},
"weight": {
"minimum": 14,
"maximum": 11,
"maximum_day": 18,
"maximum_week": 13,
"suggested": 19
},
"persons": {
"minimum": 13,
"maximum": 18
}
},
"id": 13,
"allergens": [
{
"id": 11,
"name": "Nuts"
},
{
"id": 13,
"name": "Lactose"
},
{
"id": 18,
"name": "Egg"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Nam ut et iste quod nobis ratione veniam est adipisci."
},
"description": {
"en": "Unde commodi qui exercitationem deleniti et expedita quod. Voluptas aliquid nihil est consequatur similique. Eum ut sit commodi eum."
},
"url": {
"en": "http://tillman.com/recusandae-sed-dolore-aliquid-aliquid-commodi-aliquid.html"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 13,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 15,
"maximum": 12,
"maximum_day": 10,
"maximum_week": 17
},
"weight": {
"minimum": 19,
"maximum": 11,
"maximum_day": 14,
"maximum_week": 10,
"suggested": 18
},
"persons": {
"minimum": 14,
"maximum": 16
}
},
"id": 17,
"allergens": [
{
"id": 10,
"name": "Fish"
},
{
"id": 16,
"name": "Milk"
},
{
"id": 13,
"name": "Lupine"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Eum et voluptatem voluptate maxime consequatur."
},
"description": {
"en": "Id natus iusto id sint autem accusamus aut. Inventore sunt corrupti et rem veritatis voluptatem odit rem. Inventore modi sit a id. Dolor totam officiis non porro est vitae dolorem."
},
"url": {
"en": "http://www.volkman.biz/aut-sunt-exercitationem-est-a-quia-accusantium"
}
}
}
],
"shops": [
{
"name": "Prof. Lily McGlynn",
"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": true,
"delivery_use_intervals": true,
"id": 19,
"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": "Cindy Jacobson",
"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": 11,
"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": "Miss Rae Ratke DDS",
"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": 19,
"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
}
}
],
"id": 19,
"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": "Ducimus et pariatur praesentium est provident amet totam."
},
"description": {
"en": "Distinctio ut perferendis ut sunt dolores ipsa sunt et. Aperiam voluptas quas doloribus eaque eaque suscipit numquam sapiente. Excepturi fugit non voluptatibus vel quidem excepturi sed reiciendis."
},
"url": {
"en": "http://dickens.org/et-vel-earum-provident-quidem-vel-officia-repellendus"
}
}
}