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 |
| 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 |
| 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 |
| allow_comments | 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 |
| 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": 12,
"name": "Miss Esther Lynch",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": true,
"offers": [
{
"id": 11,
"name": "Black Friday"
},
{
"id": 10,
"name": "Black Friday"
},
{
"id": 12,
"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": false,
"delivery_use_intervals": false,
"categories": [
{
"id": 13,
"name": "Benton Zieme",
"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": "Eaque quae consectetur iure odio dolores."
},
"description": {
"en": "Commodi expedita expedita iure consequuntur quibusdam dolorem. Officia ea sit eos ad exercitationem officia. Aut facere vero quae."
},
"url": {
"en": "http://block.biz/voluptatem-harum-hic-perspiciatis-eum-ducimus"
}
}
},
{
"id": 18,
"name": "Dr. Bertram Cremin MD",
"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": "Odio in ea praesentium aut veniam unde eligendi dolorem fuga eos."
},
"description": {
"en": "Aperiam dicta illo aperiam id mollitia dolores quia. Repellendus ea et ratione natus blanditiis aperiam. Modi illo itaque et. Numquam saepe minima eos quos."
},
"url": {
"en": "https://www.wilkinson.com/ipsum-aspernatur-est-voluptas-et-animi-ea-corrupti"
}
}
},
{
"id": 15,
"name": "Carissa Mitchell",
"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": "Quas commodi voluptatum ut quis magni autem commodi."
},
"description": {
"en": "Aut voluptates reprehenderit excepturi ut ut. Eius reprehenderit tenetur qui. Sed doloremque hic totam sed illo."
},
"url": {
"en": "http://www.treutel.com/"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
18,
19,
14
]
},
{
"name": "...",
"category_ids": [
11,
18,
14
]
},
{
"name": "...",
"category_ids": [
11,
11,
10
]
}
],
"allow_invoices": false,
"hours": [
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"08:10 - 17:41",
"08:10 - 17:41",
"08:10 - 17:41"
]
},
{
"days": "5",
"times": [
"06:34 - 21:17",
"06:34 - 21:17",
"06:34 - 21:17"
]
},
{
"days": "5",
"times": [
"07:18 - 21:13",
"07:18 - 21:13",
"07:18 - 21:13"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"06:14 - 21:25",
"06:14 - 21:25",
"06:14 - 21:25"
]
},
{
"days": "5",
"times": [
"08:36 - 12:59",
"08:36 - 12:59",
"08:36 - 12:59"
]
},
{
"days": "5",
"times": [
"06:15 - 15:17",
"06:15 - 15:17",
"06:15 - 15:17"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"07:31 - 10:59",
"07:31 - 10:59",
"07:31 - 10:59"
]
},
{
"days": "5",
"times": [
"09:35 - 17:45",
"09:35 - 17:45",
"09:35 - 17:45"
]
},
{
"days": "5",
"times": [
"06:46 - 18:35",
"06:46 - 18:35",
"06:46 - 18:35"
]
}
]
}
],
"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": 12,
"name": "Dr. Laverne Cormier V",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": false,
"offers": [
{
"id": 11,
"name": "Black Friday"
},
{
"id": 13,
"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_orders": true,
"delivery_use_intervals": true,
"categories": [
{
"id": 19,
"name": "Vito Eichmann Sr.",
"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": "Eaque et necessitatibus nam dolor voluptatem minima consequatur quibusdam quisquam officiis."
},
"description": {
"en": "Hic consequuntur consequuntur velit omnis. Iusto voluptas qui odit expedita est. Distinctio dignissimos labore quis quaerat deserunt recusandae eius."
},
"url": {
"en": "http://kshlerin.biz/fugit-nisi-architecto-quasi-voluptate-inventore-tempora"
}
}
},
{
"id": 11,
"name": "Mr. Evans Rogahn",
"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": "Veniam dolores voluptatem ex libero sit."
},
"description": {
"en": "Quo et qui omnis esse ut est. Sed dolorem est amet dolores sunt molestiae. Fuga sed consequatur pariatur ea aliquam quisquam."
},
"url": {
"en": "http://larkin.com/molestias-est-quia-enim-ut-aut.html"
}
}
},
{
"id": 17,
"name": "Rosella Zieme",
"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": "Id delectus nam laudantium corrupti officia quisquam possimus."
},
"description": {
"en": "Id quia sed et amet. In veritatis et est asperiores facilis non error. Est sunt sit molestiae est fugit est. Odit qui nihil voluptatem aspernatur voluptatem."
},
"url": {
"en": "https://www.veum.com/laudantium-assumenda-veniam-dolorum-necessitatibus-quisquam-quo"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
13,
18,
18
]
},
{
"name": "...",
"category_ids": [
19,
12,
11
]
},
{
"name": "...",
"category_ids": [
19,
14,
19
]
}
],
"allow_invoices": false,
"hours": [
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"09:21 - 14:24",
"09:21 - 14:24",
"09:21 - 14:24"
]
},
{
"days": "5",
"times": [
"09:28 - 13:51",
"09:28 - 13:51",
"09:28 - 13:51"
]
},
{
"days": "5",
"times": [
"09:21 - 10:32",
"09:21 - 10:32",
"09:21 - 10:32"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"09:28 - 17:29",
"09:28 - 17:29",
"09:28 - 17:29"
]
},
{
"days": "5",
"times": [
"09:14 - 20:40",
"09:14 - 20:40",
"09:14 - 20:40"
]
},
{
"days": "5",
"times": [
"09:40 - 14:47",
"09:40 - 14:47",
"09:40 - 14:47"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"08:38 - 13:58",
"08:38 - 13:58",
"08:38 - 13:58"
]
},
{
"days": "5",
"times": [
"06:30 - 17:13",
"06:30 - 17:13",
"06:30 - 17:13"
]
},
{
"days": "5",
"times": [
"06:50 - 12:40",
"06:50 - 12:40",
"06:50 - 12:40"
]
}
]
}
],
"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"
}