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": "Zetta Langosh",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"seo": {
"title": {
"en": "Earum blanditiis velit nesciunt numquam inventore iste."
},
"description": {
"en": "Pariatur enim consequuntur eligendi officia nemo. Qui labore illum velit cumque est modi. Dignissimos molestiae non laboriosam debitis labore."
},
"url": {
"en": "http://www.kiehn.biz/quas-explicabo-eum-ab-ipsam-voluptatem-repudiandae"
}
}
}When returned in a response.
{
"name": "Roberta Becker",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"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": 16,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 16,
"maximum": 17,
"maximum_day": 18,
"maximum_week": 19
},
"weight": {
"minimum": 12,
"maximum": 10,
"maximum_day": 12,
"maximum_week": 16,
"suggested": 13
},
"persons": {
"minimum": 14,
"maximum": 12
}
},
"id": 13,
"allergens": [
{
"id": 16,
"name": "Mustard"
},
{
"id": 15,
"name": "Milk"
},
{
"id": 12,
"name": "Peanut"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Et atque beatae et aut voluptatibus consequatur esse velit iste sed."
},
"description": {
"en": "Pariatur facere quia maxime vel nam. Autem numquam adipisci voluptatem tempora quos aliquam. Fugit in qui et omnis. Ut architecto totam magnam ut facere."
},
"url": {
"en": "http://sipes.com/aut-eligendi-perspiciatis-aspernatur"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"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": 15,
"maximum": 19,
"maximum_day": 16,
"maximum_week": 14
},
"weight": {
"minimum": 15,
"maximum": 16,
"maximum_day": 14,
"maximum_week": 15,
"suggested": 13
},
"persons": {
"minimum": 12,
"maximum": 10
}
},
"id": 18,
"allergens": [
{
"id": 18,
"name": "Egg"
},
{
"id": 15,
"name": "Celery"
},
{
"id": 16,
"name": "Sulphite"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Enim doloremque magnam nihil voluptatum cumque accusamus."
},
"description": {
"en": "Eos ut hic nemo qui unde. Iusto qui porro et et ut fuga voluptatum. Ab sit maxime tempore pariatur qui est est. Dignissimos nulla non quia."
},
"url": {
"en": "http://www.casper.com/laborum-neque-velit-tempore-qui"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 16,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 13,
"maximum": 11,
"maximum_day": 15,
"maximum_week": 18
},
"weight": {
"minimum": 14,
"maximum": 14,
"maximum_day": 16,
"maximum_week": 15,
"suggested": 14
},
"persons": {
"minimum": 16,
"maximum": 15
}
},
"id": 13,
"allergens": [
{
"id": 16,
"name": "Egg"
},
{
"id": 11,
"name": "Fish"
},
{
"id": 18,
"name": "Sesame"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Aut consectetur tempora velit numquam cupiditate sit nemo."
},
"description": {
"en": "Autem quia ipsum perferendis. Aliquam cupiditate minima saepe aut debitis itaque ratione quaerat. Aperiam doloremque dolores unde et eaque nobis. Ea a doloremque placeat distinctio."
},
"url": {
"en": "http://monahan.info/"
}
}
}
],
"shops": [
{
"name": "Mrs. Ardella Bogan",
"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,
"id": 18,
"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": false
}
},
{
"name": "Era Lehner",
"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": 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": "Madison Kozey",
"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": true,
"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": true
}
}
],
"id": 15,
"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": "Mollitia blanditiis officia repellat debitis in itaque qui sunt."
},
"description": {
"en": "Et est incidunt dicta molestiae ut nam dolor sit. Illo cum consectetur tenetur et minima adipisci id. Rerum dignissimos nulla repellat odio neque occaecati."
},
"url": {
"en": "http://www.jacobs.com/"
}
}
}