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 |
| offers | [Offer.simple] | Array of Offer.simple |
| images | [String: Image] | Dictionary of Image with keys of type String |
| allow_comments | Bool | A boolean value |
| 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. |
| 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 |
| 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 |
| offers | [Offer.simple] | Array of Offer.simple |
| images | [String: Image] | Dictionary of Image with keys of type String |
| allow_comments | Bool | A boolean value |
| 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. |
| 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 |
| currency | Currency | 3 letter ISO 4217 currency name (string) |
When used inside a request.
{
"id": 13,
"name": "Ms. Magdalena Sauer DVM",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"offers": [
{
"id": 13,
"name": "...",
"items": [
{
"type": "product",
"item_id": 16,
"percentage": 13,
"minimum": 17
},
{
"type": "product",
"item_id": 10,
"percentage": 16,
"minimum": 13
},
{
"type": "product",
"item_id": 16,
"percentage": 19,
"minimum": 14
}
]
},
{
"id": 18,
"name": "...",
"items": [
{
"type": "product",
"item_id": 11,
"percentage": 15,
"minimum": 12
},
{
"type": "product",
"item_id": 14,
"percentage": 10,
"minimum": 16
},
{
"type": "product",
"item_id": 12,
"percentage": 12,
"minimum": 13
}
]
},
{
"id": 12,
"name": "...",
"items": [
{
"type": "product",
"item_id": 13,
"percentage": 15,
"minimum": 12
},
{
"type": "product",
"item_id": 13,
"percentage": 18,
"minimum": 15
},
{
"type": "product",
"item_id": 17,
"percentage": 14,
"minimum": 15
}
]
}
],
"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_comments": false,
"allow_orders": false,
"delivery_use_intervals": false,
"categories": [
{
"id": 18,
"name": "Prof. Carson Fay",
"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": "Numquam nostrum beatae reprehenderit omnis."
},
"description": {
"en": "Ipsa aut aut corrupti fuga non. Blanditiis voluptas omnis molestias aut enim. Odio aperiam animi ipsum natus ipsum. Vitae eum ex iure recusandae."
},
"url": {
"en": "http://www.nolan.biz/"
}
}
},
{
"id": 12,
"name": "Dorothy Runolfsdottir",
"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": "Odit et dignissimos ut eos consectetur cupiditate similique."
},
"description": {
"en": "Illo aut dolorem repudiandae delectus debitis ipsa neque excepturi. Nemo inventore quod qui reiciendis est sed reprehenderit. Commodi earum quaerat fugit nostrum. A quo qui nihil et vero ut id."
},
"url": {
"en": "https://swift.com/est-consequuntur-consequuntur-rerum-velit.html"
}
}
},
{
"id": 16,
"name": "Modesto Wilkinson III",
"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": "Facere nostrum vero iure iste officiis ut."
},
"description": {
"en": "Est exercitationem et sunt voluptatem perspiciatis consectetur sit. Sunt nihil accusamus maxime ipsum minima et. Voluptate optio ab adipisci cum."
},
"url": {
"en": "http://adams.com/nihil-eaque-numquam-explicabo-eos-minus-veritatis-possimus"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
12,
16,
13
]
},
{
"name": "...",
"category_ids": [
19,
11,
11
]
},
{
"name": "...",
"category_ids": [
17,
15,
10
]
}
],
"hours": [
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"08:52 - 20:21",
"08:52 - 20:21",
"08:52 - 20:21"
]
},
{
"days": "5",
"times": [
"08:11 - 15:52",
"08:11 - 15:52",
"08:11 - 15:52"
]
},
{
"days": "5",
"times": [
"09:51 - 19:56",
"09:51 - 19:56",
"09:51 - 19:56"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"06:31 - 13:41",
"06:31 - 13:41",
"06:31 - 13:41"
]
},
{
"days": "5",
"times": [
"06:16 - 10:27",
"06:16 - 10:27",
"06:16 - 10:27"
]
},
{
"days": "5",
"times": [
"07:19 - 18:41",
"07:19 - 18:41",
"07:19 - 18:41"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"07:48 - 10:17",
"07:48 - 10:17",
"07:48 - 10:17"
]
},
{
"days": "5",
"times": [
"06:10 - 21:47",
"06:10 - 21:47",
"06:10 - 21:47"
]
},
{
"days": "5",
"times": [
"06:40 - 19:55",
"06:40 - 19:55",
"06:40 - 19:55"
]
}
]
}
],
"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"
}
],
"currency": "EUR"
}When returned in a response.
{
"id": 16,
"name": "Dr. Reyna Braun",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"offers": [
{
"id": 17,
"name": "...",
"items": [
{
"type": "product",
"item_id": 18,
"percentage": 15,
"minimum": 15
},
{
"type": "product",
"item_id": 19,
"percentage": 15,
"minimum": 11
},
{
"type": "product",
"item_id": 13,
"percentage": 12,
"minimum": 12
}
]
},
{
"id": 19,
"name": "...",
"items": [
{
"type": "product",
"item_id": 13,
"percentage": 17,
"minimum": 11
},
{
"type": "product",
"item_id": 12,
"percentage": 16,
"minimum": 11
},
{
"type": "product",
"item_id": 16,
"percentage": 17,
"minimum": 13
}
]
},
{
"id": 16,
"name": "...",
"items": [
{
"type": "product",
"item_id": 10,
"percentage": 13,
"minimum": 15
},
{
"type": "product",
"item_id": 12,
"percentage": 17,
"minimum": 11
},
{
"type": "product",
"item_id": 15,
"percentage": 17,
"minimum": 12
}
]
}
],
"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_comments": true,
"allow_orders": false,
"delivery_use_intervals": false,
"categories": [
{
"id": 18,
"name": "Kelli Walter",
"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": "Officiis quas ea et ducimus reprehenderit rerum ut eos sit."
},
"description": {
"en": "Laudantium ab qui praesentium dolores. Libero ratione cumque nostrum harum ut error similique. Dolor ea est vel non iure tenetur asperiores. Voluptas et a numquam quo ea rerum qui."
},
"url": {
"en": "http://www.wiegand.com/id-officia-deserunt-quas"
}
}
},
{
"id": 15,
"name": "Justice Nolan",
"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": "Omnis natus occaecati autem quisquam quod voluptates dolorem nobis assumenda vero."
},
"description": {
"en": "Quod quos eum voluptas. Vitae voluptatem nihil quidem aperiam."
},
"url": {
"en": "http://www.bradtke.com/sint-qui-et-repellendus"
}
}
},
{
"id": 19,
"name": "Carlee Gerhold",
"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": "Repudiandae esse iusto autem labore non eum nemo vitae voluptatibus qui."
},
"description": {
"en": "Recusandae consequatur reiciendis optio et eos. Dolorum eligendi sit corporis quam sunt. Cumque dolor error eum aut natus. Qui exercitationem eos molestiae veritatis cum voluptates praesentium."
},
"url": {
"en": "http://www.lueilwitz.com/blanditiis-facere-itaque-eum-maiores-suscipit-nesciunt-consectetur"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
18,
10,
18
]
},
{
"name": "...",
"category_ids": [
15,
12,
15
]
},
{
"name": "...",
"category_ids": [
14,
15,
16
]
}
],
"hours": [
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"06:46 - 16:23",
"06:46 - 16:23",
"06:46 - 16:23"
]
},
{
"days": "5",
"times": [
"07:33 - 17:46",
"07:33 - 17:46",
"07:33 - 17:46"
]
},
{
"days": "5",
"times": [
"06:49 - 21:48",
"06:49 - 21:48",
"06:49 - 21:48"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"08:53 - 17:21",
"08:53 - 17:21",
"08:53 - 17:21"
]
},
{
"days": "5",
"times": [
"08:54 - 16:24",
"08:54 - 16:24",
"08:54 - 16:24"
]
},
{
"days": "5",
"times": [
"08:47 - 13:48",
"08:47 - 13:48",
"08:47 - 13:48"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"08:51 - 14:34",
"08:51 - 14:34",
"08:51 - 14:34"
]
},
{
"days": "5",
"times": [
"08:16 - 19:52",
"08:16 - 19:52",
"08:16 - 19:52"
]
},
{
"days": "5",
"times": [
"06:50 - 21:21",
"06:50 - 21:21",
"06:50 - 21:21"
]
}
]
}
],
"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"
}
],
"currency": "EUR"
}