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": "Elva Larkin",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"offers": [
{
"id": 18,
"name": "Black Friday"
},
{
"id": 18,
"name": "Black Friday"
},
{
"id": 18,
"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_comments": true,
"allow_orders": true,
"delivery_use_intervals": false,
"categories": [
{
"id": 14,
"name": "Prof. Serenity Tromp",
"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": "Eius quo quod id numquam in."
},
"description": {
"en": "Fugit ea eaque molestiae non sed. Eveniet repellat id dolor molestiae distinctio voluptas iste. Voluptas inventore voluptatem repudiandae quas. Sed sed quia eum corrupti aperiam vitae esse."
},
"url": {
"en": "http://bins.net/"
}
}
},
{
"id": 14,
"name": "Eliza Quigley",
"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": "Voluptates expedita quos quaerat pariatur dolorem ad odio."
},
"description": {
"en": "Ducimus voluptas omnis necessitatibus consequuntur corrupti quo qui. Aperiam aut eius earum impedit. Consequatur quaerat nisi optio dolorem molestiae in tenetur repellendus."
},
"url": {
"en": "http://jast.com/totam-non-ipsum-aperiam-libero-eveniet-eaque-fuga"
}
}
},
{
"id": 13,
"name": "Kaelyn Oberbrunner",
"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": "Fugiat harum autem incidunt sint corrupti repellendus fuga facere eaque ut."
},
"description": {
"en": "Maxime culpa officiis consequatur molestiae aut odit. Itaque minus ut voluptatem iusto rerum ut."
},
"url": {
"en": "http://turcotte.com/ipsum-molestiae-et-omnis-non-delectus"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
14,
12,
13
]
},
{
"name": "...",
"category_ids": [
18,
17,
16
]
},
{
"name": "...",
"category_ids": [
18,
11,
13
]
}
],
"hours": [
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"09:47 - 17:13",
"09:47 - 17:13",
"09:47 - 17:13"
]
},
{
"days": "5",
"times": [
"08:17 - 14:57",
"08:17 - 14:57",
"08:17 - 14:57"
]
},
{
"days": "5",
"times": [
"09:12 - 21:14",
"09:12 - 21:14",
"09:12 - 21:14"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"06:33 - 19:44",
"06:33 - 19:44",
"06:33 - 19:44"
]
},
{
"days": "5",
"times": [
"06:54 - 15:20",
"06:54 - 15:20",
"06:54 - 15:20"
]
},
{
"days": "5",
"times": [
"07:58 - 16:43",
"07:58 - 16:43",
"07:58 - 16:43"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"09:19 - 14:18",
"09:19 - 14:18",
"09:19 - 14:18"
]
},
{
"days": "5",
"times": [
"06:19 - 16:36",
"06:19 - 16:36",
"06:19 - 16:36"
]
},
{
"days": "5",
"times": [
"09:15 - 18:48",
"09:15 - 18:48",
"09:15 - 18:48"
]
}
]
}
],
"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": 13,
"name": "Dr. Santina Flatley MD",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"offers": [
{
"id": 16,
"name": "Black Friday"
},
{
"id": 19,
"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_comments": false,
"allow_orders": false,
"delivery_use_intervals": false,
"categories": [
{
"id": 15,
"name": "Robin Bins DDS",
"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": "Dolorem tempora quia iusto neque beatae necessitatibus consequuntur assumenda et rem voluptate."
},
"description": {
"en": "Praesentium deserunt inventore et tempora non consequuntur temporibus et. Itaque sapiente nihil nesciunt odit et aut ex necessitatibus. Eligendi earum nulla eum quasi."
},
"url": {
"en": "http://schinner.com/qui-omnis-tempora-amet-nihil-qui"
}
}
},
{
"id": 12,
"name": "Marjorie Toy",
"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": "Voluptatem eveniet et facilis voluptatibus ea ipsam quaerat illum nobis voluptas."
},
"description": {
"en": "Corrupti ullam incidunt sed qui. Labore facilis neque enim quasi. Perspiciatis est dicta officia sed corporis autem."
},
"url": {
"en": "http://www.hansen.biz/"
}
}
},
{
"id": 12,
"name": "Prof. Carmelo Feil",
"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": "Enim eum assumenda dicta eum dignissimos."
},
"description": {
"en": "Molestias maxime quasi delectus nobis qui. Odit nemo ducimus excepturi nihil. Aut corrupti aut aut at voluptatem eaque."
},
"url": {
"en": "http://corkery.com/tempore-aut-dolore-dolorem-aut-voluptatem-sint.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
15,
11,
10
]
},
{
"name": "...",
"category_ids": [
18,
16,
18
]
},
{
"name": "...",
"category_ids": [
17,
14,
14
]
}
],
"hours": [
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"06:17 - 16:54",
"06:17 - 16:54",
"06:17 - 16:54"
]
},
{
"days": "5",
"times": [
"09:28 - 19:11",
"09:28 - 19:11",
"09:28 - 19:11"
]
},
{
"days": "5",
"times": [
"07:53 - 13:43",
"07:53 - 13:43",
"07:53 - 13:43"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"08:13 - 14:26",
"08:13 - 14:26",
"08:13 - 14:26"
]
},
{
"days": "5",
"times": [
"08:23 - 10:52",
"08:23 - 10:52",
"08:23 - 10:52"
]
},
{
"days": "5",
"times": [
"09:30 - 21:29",
"09:30 - 21:29",
"09:30 - 21:29"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"08:27 - 19:44",
"08:27 - 19:44",
"08:27 - 19:44"
]
},
{
"days": "5",
"times": [
"06:18 - 10:13",
"06:18 - 10:13",
"06:18 - 10:13"
]
},
{
"days": "5",
"times": [
"08:48 - 12:34",
"08:48 - 12:34",
"08:48 - 12:34"
]
}
]
}
],
"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"
}