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": 11,
"name": "Richard Buckridge",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"offers": [
{
"id": 11,
"name": "...",
"items": [
{
"type": "product",
"item_id": 18,
"percentage": 16,
"minimum": 18
},
{
"type": "product",
"item_id": 14,
"percentage": 14,
"minimum": 10
},
{
"type": "product",
"item_id": 13,
"percentage": 13,
"minimum": 12
}
]
},
{
"id": 16,
"name": "...",
"items": [
{
"type": "product",
"item_id": 17,
"percentage": 18,
"minimum": 17
},
{
"type": "product",
"item_id": 19,
"percentage": 13,
"minimum": 12
},
{
"type": "product",
"item_id": 12,
"percentage": 11,
"minimum": 16
}
]
},
{
"id": 10,
"name": "...",
"items": [
{
"type": "product",
"item_id": 10,
"percentage": 19,
"minimum": 18
},
{
"type": "product",
"item_id": 18,
"percentage": 18,
"minimum": 12
},
{
"type": "product",
"item_id": 18,
"percentage": 15,
"minimum": 19
}
]
}
],
"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": 10,
"name": "Demario Kunde 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": "Officia eos quisquam enim omnis repellendus provident."
},
"description": {
"en": "Sed omnis ut eos repudiandae ipsam enim et. Eos qui distinctio ut fuga sint. Eveniet asperiores qui saepe atque. Distinctio accusamus aliquam vel quisquam eius architecto aut."
},
"url": {
"en": "http://mcclure.com/eius-eveniet-qui-provident-debitis"
}
}
},
{
"id": 19,
"name": "Gussie Beatty",
"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": "Consectetur praesentium numquam temporibus vel consequatur aut quasi labore vel."
},
"description": {
"en": "Et velit quia eligendi tempora. Quisquam eligendi molestiae nobis cum nihil quod. Autem magnam itaque illo error qui omnis vitae. Quo dolore at omnis."
},
"url": {
"en": "http://kshlerin.com/blanditiis-sunt-eum-qui-est-reprehenderit-blanditiis-repellat"
}
}
},
{
"id": 12,
"name": "Emma Franecki",
"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": "Esse doloribus unde velit veritatis odio repudiandae adipisci perferendis repellendus."
},
"description": {
"en": "Est illo quia iusto qui. Omnis nulla ad tempore cumque nihil dolor labore. Perspiciatis harum vero officia rerum quo quis quam."
},
"url": {
"en": "http://kling.org/alias-deleniti-provident-doloremque-commodi-aut"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
17,
15,
15
]
},
{
"name": "...",
"category_ids": [
17,
11,
16
]
},
{
"name": "...",
"category_ids": [
19,
16,
14
]
}
],
"hours": [
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"09:55 - 20:24",
"09:55 - 20:24",
"09:55 - 20:24"
]
},
{
"days": "5",
"times": [
"06:54 - 12:46",
"06:54 - 12:46",
"06:54 - 12:46"
]
},
{
"days": "5",
"times": [
"08:47 - 18:27",
"08:47 - 18:27",
"08:47 - 18:27"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"06:40 - 11:15",
"06:40 - 11:15",
"06:40 - 11:15"
]
},
{
"days": "5",
"times": [
"08:43 - 20:53",
"08:43 - 20:53",
"08:43 - 20:53"
]
},
{
"days": "5",
"times": [
"07:37 - 20:57",
"07:37 - 20:57",
"07:37 - 20:57"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"09:10 - 15:27",
"09:10 - 15:27",
"09:10 - 15:27"
]
},
{
"days": "5",
"times": [
"08:43 - 16:29",
"08:43 - 16:29",
"08:43 - 16:29"
]
},
{
"days": "5",
"times": [
"09:17 - 18:55",
"09:17 - 18:55",
"09:17 - 18: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": 19,
"name": "Ms. Kaylin Adams I",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"offers": [
{
"id": 19,
"name": "...",
"items": [
{
"type": "product",
"item_id": 15,
"percentage": 13,
"minimum": 10
},
{
"type": "product",
"item_id": 12,
"percentage": 15,
"minimum": 10
},
{
"type": "product",
"item_id": 14,
"percentage": 19,
"minimum": 12
}
]
},
{
"id": 12,
"name": "...",
"items": [
{
"type": "product",
"item_id": 14,
"percentage": 11,
"minimum": 16
},
{
"type": "product",
"item_id": 14,
"percentage": 14,
"minimum": 10
},
{
"type": "product",
"item_id": 13,
"percentage": 14,
"minimum": 12
}
]
},
{
"id": 14,
"name": "...",
"items": [
{
"type": "product",
"item_id": 16,
"percentage": 17,
"minimum": 14
},
{
"type": "product",
"item_id": 12,
"percentage": 17,
"minimum": 19
},
{
"type": "product",
"item_id": 10,
"percentage": 18,
"minimum": 19
}
]
}
],
"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": false,
"allow_orders": false,
"delivery_use_intervals": false,
"categories": [
{
"id": 10,
"name": "Prof. Orlo Koelpin 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": "Quae voluptas ut placeat harum non sunt iusto."
},
"description": {
"en": "Debitis et harum illum eos eaque nihil rerum. Itaque aut doloremque ducimus consequatur voluptas dolorum. Qui molestias et excepturi et. Aut dolores deleniti et quis."
},
"url": {
"en": "https://www.kiehn.biz/quidem-ipsa-exercitationem-alias-debitis-minus-debitis"
}
}
},
{
"id": 12,
"name": "Gerry Cartwright",
"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 omnis expedita sit distinctio iure consectetur non."
},
"description": {
"en": "Eum consequuntur enim architecto deserunt enim rerum est qui. Voluptatibus quo sunt dolorum aut quas aspernatur animi."
},
"url": {
"en": "http://ratke.com/non-rerum-provident-dolorum-cumque-reprehenderit-nulla.html"
}
}
},
{
"id": 18,
"name": "Ryley Ernser",
"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": "Est asperiores nobis nulla aut quisquam."
},
"description": {
"en": "Dignissimos qui sed et. Culpa sed provident eligendi eum. Quod ea dignissimos suscipit enim vel iste sequi. Et non omnis eos fuga et enim. Esse optio iusto minus vitae sit."
},
"url": {
"en": "http://www.reichel.com/sed-sit-quam-perspiciatis-odio-eius"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
10,
14,
15
]
},
{
"name": "...",
"category_ids": [
14,
15,
13
]
},
{
"name": "...",
"category_ids": [
17,
14,
15
]
}
],
"hours": [
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"06:59 - 20:49",
"06:59 - 20:49",
"06:59 - 20:49"
]
},
{
"days": "5",
"times": [
"07:44 - 12:18",
"07:44 - 12:18",
"07:44 - 12:18"
]
},
{
"days": "5",
"times": [
"09:15 - 17:39",
"09:15 - 17:39",
"09:15 - 17:39"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"08:55 - 10:15",
"08:55 - 10:15",
"08:55 - 10:15"
]
},
{
"days": "5",
"times": [
"06:33 - 21:23",
"06:33 - 21:23",
"06:33 - 21:23"
]
},
{
"days": "5",
"times": [
"09:30 - 12:11",
"09:30 - 12:11",
"09:30 - 12:11"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"06:25 - 14:43",
"06:25 - 14:43",
"06:25 - 14:43"
]
},
{
"days": "5",
"times": [
"08:34 - 16:39",
"08:34 - 16:39",
"08:34 - 16:39"
]
},
{
"days": "5",
"times": [
"07:41 - 16:51",
"07:41 - 16:51",
"07:41 - 16:51"
]
}
]
}
],
"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"
}