Fields when send to the api inside a request.
| Field | Type | Description |
|---|---|---|
| id | Int | Id of the shop |
| name | String | Name of the shop (translated) |
| address | Address.detailed | An address |
| allow_comments | Bool | A boolean value |
| url | String | A String value |
| allow_order_comments | Bool | A boolean value |
| allow_product_comments | Bool | A boolean value |
| allow_order_messages | Bool | A boolean value |
| offers | [Offer.simple] | Array of Offer.simple |
| images | [String: Image] | Dictionary of Image with keys of type String |
| allow_orders | Bool | A boolean value |
| delivery_use_intervals | Bool | A boolean value |
| categories | [Category.simple] | Array of Category.simple |
| category_groups | [CategoryGroup] | List of category groups. The ids refer to a category in the categories field. Categories without a CategoryGroup should also get displayed. |
| allow_invoices | Bool | A boolean value |
| category_groups_overview | Bool | Show an overview of all the category groups on the webshop homepage |
| display_mode | String | String enumarion of 'blocks', 'list' |
| takeout_use_intervals | Bool | A boolean value |
| joyn_enabled | Bool | A boolean value |
| category_overview | Bool | Show an overview of all the categories on the webshop homepage |
| fold_category_groups | Bool | Whether the shop prefers to hide all the categories for all category groups by default |
| hours | [MethodHours] | Information about the opening hours, delivery hours... for all available methods and machines |
| contact | Contact | Contact details of a shop |
| messages | [Message] | You are required to keep track of the messages the user saw. When you receive new messages, you should indicate this in the app with a bubble icon (e.g. red circle with number of new messages) |
| info | [Message] | Same as messages, but you shouldn't notify the user when this changes or is received for the first time |
| status | ShopStatus | |
| has_specialties | Bool | A boolean value |
| currency | Currency | 3 letter ISO 4217 currency name (string) |
Fields when returned by the api in a response.
| Field | Type | Description |
|---|---|---|
| id | Int | Id of the shop |
| name | String | Name of the shop (translated) |
| address | Address.detailed | An address |
| allow_comments | Bool | A boolean value |
| url | String | A String value |
| allow_order_comments | Bool | A boolean value |
| allow_product_comments | Bool | A boolean value |
| allow_order_messages | Bool | A boolean value |
| offers | [Offer.simple] | Array of Offer.simple |
| images | [String: Image] | Dictionary of Image with keys of type String |
| allow_orders | Bool | A boolean value |
| delivery_use_intervals | Bool | A boolean value |
| categories | [Category.simple] | Array of Category.simple |
| category_groups | [CategoryGroup] | List of category groups. The ids refer to a category in the categories field. Categories without a CategoryGroup should also get displayed. |
| allow_invoices | Bool | A boolean value |
| category_groups_overview | Bool | Show an overview of all the category groups on the webshop homepage |
| display_mode | String | String enumarion of 'blocks', 'list' |
| takeout_use_intervals | Bool | A boolean value |
| joyn_enabled | Bool | A boolean value |
| category_overview | Bool | Show an overview of all the categories on the webshop homepage |
| fold_category_groups | Bool | Whether the shop prefers to hide all the categories for all category groups by default |
| hours | [MethodHours] | Information about the opening hours, delivery hours... for all available methods and machines |
| contact | Contact | Contact details of a shop |
| messages | [Message] | You are required to keep track of the messages the user saw. When you receive new messages, you should indicate this in the app with a bubble icon (e.g. red circle with number of new messages) |
| info | [Message] | Same as messages, but you shouldn't notify the user when this changes or is received for the first time |
| status | ShopStatus | |
| has_specialties | Bool | A boolean value |
| currency | Currency | 3 letter ISO 4217 currency name (string) |
When used inside a request.
{
"id": 12,
"name": "Abdiel Heidenreich",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": true,
"url": "...",
"allow_order_comments": true,
"allow_product_comments": true,
"allow_order_messages": false,
"offers": [
{
"id": 14,
"name": "Black Friday"
},
{
"id": 17,
"name": "Black Friday"
},
{
"id": 16,
"name": "Black Friday"
}
],
"images": {
"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
}
},
"allow_orders": true,
"delivery_use_intervals": false,
"categories": [
{
"id": 10,
"name": "Annabel Murazik",
"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
},
"only_order_in_store": false,
"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
},
"seo": {
"title": {
"en": "Cum ad perspiciatis saepe asperiores tempore fuga."
},
"description": {
"en": "Voluptatem autem corporis est ut quia. Vitae omnis fugit non voluptatem. Quaerat assumenda exercitationem architecto nihil. Quaerat numquam ut adipisci maiores voluptas corporis occaecati."
},
"url": {
"en": "http://adams.com/officia-sunt-rerum-quidem-fuga"
}
}
},
{
"id": 14,
"name": "Cierra Herman",
"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
},
"only_order_in_store": false,
"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
},
"seo": {
"title": {
"en": "Omnis sint provident nihil ut fugiat blanditiis alias."
},
"description": {
"en": "Voluptas vel quaerat praesentium laborum aut enim ipsa. Voluptatibus aut in possimus at repellat placeat ut. Consequatur aliquam repellendus id autem."
},
"url": {
"en": "http://www.ernser.com/quaerat-tempore-eum-quisquam-ea-enim"
}
}
},
{
"id": 13,
"name": "Marshall Greenfelder",
"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
},
"only_order_in_store": false,
"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
},
"seo": {
"title": {
"en": "Quia ullam dolorem fugit laboriosam molestiae et aliquam dolor."
},
"description": {
"en": "Officiis et dignissimos quidem quae. Et qui eius natus dignissimos. Voluptas porro sed numquam sit. Est atque eum officiis."
},
"url": {
"en": "http://west.org/"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
13,
10,
18
],
"id": 16,
"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
}
},
{
"name": "...",
"category_ids": [
10,
10,
17
],
"id": 11,
"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
}
},
{
"name": "...",
"category_ids": [
13,
13,
17
],
"id": 15,
"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
}
}
],
"allow_invoices": false,
"category_groups_overview": false,
"display_mode": "blocks",
"takeout_use_intervals": true,
"joyn_enabled": true,
"category_overview": false,
"fold_category_groups": false,
"hours": [
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"06:51 - 17:41",
"06:51 - 17:41",
"06:51 - 17:41"
]
},
{
"days": "5",
"times": [
"09:58 - 17:20",
"09:58 - 17:20",
"09:58 - 17:20"
]
},
{
"days": "5",
"times": [
"09:50 - 21:49",
"09:50 - 21:49",
"09:50 - 21:49"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"06:42 - 10:56",
"06:42 - 10:56",
"06:42 - 10:56"
]
},
{
"days": "5",
"times": [
"08:36 - 15:45",
"08:36 - 15:45",
"08:36 - 15:45"
]
},
{
"days": "5",
"times": [
"09:18 - 20:30",
"09:18 - 20:30",
"09:18 - 20:30"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"06:51 - 12:28",
"06:51 - 12:28",
"06:51 - 12:28"
]
},
{
"days": "5",
"times": [
"09:15 - 16:30",
"09:15 - 16:30",
"09:15 - 16:30"
]
},
{
"days": "5",
"times": [
"06:25 - 16:10",
"06:25 - 16:10",
"06:25 - 16:10"
]
}
]
}
],
"contact": {
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"telephone": "+32 475 00 00 00",
"vat": "BE0123.456.789",
"social": {
"facebook": "https://example.com",
"twitter": "https://example.com",
"snapchat": "https://example.com",
"instagram": "https://example.com",
"pinterest": "https://example.com",
"youtube": "https://example.com"
},
"website": "https://example.com",
"email": "example@domain.com"
},
"messages": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
],
"info": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
],
"status": {
"open": {
"status": "closes-soon",
"text": "..."
},
"takeout": "...",
"delivery": "...",
"latch": "..."
},
"has_specialties": true,
"currency": "EUR"
}When returned in a response.
{
"id": 17,
"name": "Henriette Berge",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": false,
"url": "...",
"allow_order_comments": true,
"allow_product_comments": true,
"allow_order_messages": false,
"offers": [
{
"id": 17,
"name": "Black Friday"
},
{
"id": 15,
"name": "Black Friday"
},
{
"id": 11,
"name": "Black Friday"
}
],
"images": {
"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
}
},
"allow_orders": true,
"delivery_use_intervals": false,
"categories": [
{
"id": 11,
"name": "Prof. Jasper Runolfsson",
"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
},
"only_order_in_store": false,
"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
},
"seo": {
"title": {
"en": "Sint et aut qui tempore doloribus quo pariatur adipisci."
},
"description": {
"en": "Quaerat voluptatum provident et aliquid rerum. Quis tempora vel quo dolore. Et doloribus provident illum."
},
"url": {
"en": "http://white.com/ut-repellendus-accusamus-molestias-repellat-vitae-cumque.html"
}
}
},
{
"id": 16,
"name": "Haleigh Sauer II",
"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
},
"only_order_in_store": false,
"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
},
"seo": {
"title": {
"en": "Rerum assumenda quo ea sit debitis cumque aperiam voluptatem."
},
"description": {
"en": "Voluptatem nostrum corporis eligendi in. Corrupti reiciendis asperiores aut beatae qui ad. Corrupti similique voluptatem veniam et ullam rerum."
},
"url": {
"en": "http://www.baumbach.org/"
}
}
},
{
"id": 10,
"name": "Dr. Hester Durgan",
"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
},
"only_order_in_store": false,
"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
},
"seo": {
"title": {
"en": "Nobis delectus maxime voluptate eum vero eum eligendi saepe quae quidem."
},
"description": {
"en": "Occaecati aspernatur porro eaque provident qui animi. Est sunt possimus dolorem itaque deleniti quidem. Id quod et voluptas ad possimus."
},
"url": {
"en": "http://www.lockman.com/eligendi-eum-non-sed-molestiae-et.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
19,
15,
19
],
"id": 10,
"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
}
},
{
"name": "...",
"category_ids": [
15,
11,
15
],
"id": 11,
"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
}
},
{
"name": "...",
"category_ids": [
11,
10,
14
],
"id": 19,
"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
}
}
],
"allow_invoices": true,
"category_groups_overview": true,
"display_mode": "blocks",
"takeout_use_intervals": true,
"joyn_enabled": false,
"category_overview": true,
"fold_category_groups": true,
"hours": [
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"07:29 - 16:19",
"07:29 - 16:19",
"07:29 - 16:19"
]
},
{
"days": "5",
"times": [
"08:33 - 19:37",
"08:33 - 19:37",
"08:33 - 19:37"
]
},
{
"days": "5",
"times": [
"07:23 - 15:18",
"07:23 - 15:18",
"07:23 - 15:18"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"06:16 - 13:31",
"06:16 - 13:31",
"06:16 - 13:31"
]
},
{
"days": "5",
"times": [
"07:44 - 19:40",
"07:44 - 19:40",
"07:44 - 19:40"
]
},
{
"days": "5",
"times": [
"07:54 - 18:54",
"07:54 - 18:54",
"07:54 - 18:54"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"07:33 - 18:53",
"07:33 - 18:53",
"07:33 - 18:53"
]
},
{
"days": "5",
"times": [
"08:35 - 10:39",
"08:35 - 10:39",
"08:35 - 10:39"
]
},
{
"days": "5",
"times": [
"08:15 - 11:47",
"08:15 - 11:47",
"08:15 - 11:47"
]
}
]
}
],
"contact": {
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"telephone": "+32 475 00 00 00",
"vat": "BE0123.456.789",
"social": {
"facebook": "https://example.com",
"twitter": "https://example.com",
"snapchat": "https://example.com",
"instagram": "https://example.com",
"pinterest": "https://example.com",
"youtube": "https://example.com"
},
"website": "https://example.com",
"email": "example@domain.com"
},
"messages": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
],
"info": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
],
"status": {
"open": {
"status": "closes-soon",
"text": "..."
},
"takeout": "...",
"delivery": "...",
"latch": "..."
},
"has_specialties": false,
"currency": "EUR"
}