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 | HoursInfo | Information about opening hours and other delivery method hours |
| 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 |
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 | HoursInfo | Information about opening hours and other delivery method hours |
| 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 |
When used inside a request.
{
"id": 14,
"name": "Joanie Daugherty",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"offers": [
{
"id": 13,
"name": "...",
"items": [
{
"type": "product",
"item_id": 16,
"percentage": 18,
"minimum": 17
},
{
"type": "product",
"item_id": 15,
"percentage": 19,
"minimum": 11
},
{
"type": "product",
"item_id": 17,
"percentage": 14,
"minimum": 10
}
]
},
{
"id": 16,
"name": "...",
"items": [
{
"type": "product",
"item_id": 13,
"percentage": 12,
"minimum": 12
},
{
"type": "product",
"item_id": 14,
"percentage": 13,
"minimum": 11
},
{
"type": "product",
"item_id": 13,
"percentage": 11,
"minimum": 14
}
]
},
{
"id": 19,
"name": "...",
"items": [
{
"type": "product",
"item_id": 15,
"percentage": 18,
"minimum": 14
},
{
"type": "product",
"item_id": 13,
"percentage": 12,
"minimum": 17
},
{
"type": "product",
"item_id": 15,
"percentage": 17,
"minimum": 16
}
]
}
],
"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": true,
"allow_orders": false,
"delivery_use_intervals": false,
"categories": [
{
"id": 15,
"name": "Mrs. Donna Dickinson",
"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": "Ipsum ut iusto aliquam fuga voluptatibus est officia."
},
"description": {
"en": "Sed voluptas totam doloribus vero quo. Exercitationem dolores et consequuntur nihil ex nobis qui laborum. Omnis architecto quas laudantium magni distinctio enim aut."
},
"url": {
"en": "https://www.white.com/maiores-ut-labore-in-sunt-totam-qui-nostrum"
}
}
},
{
"id": 12,
"name": "Kenneth Mante",
"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": "Neque eveniet est consequuntur aut ea sed."
},
"description": {
"en": "Est repellendus dolor non fuga atque qui harum. Eos vel perferendis quibusdam vel natus voluptatem. Voluptates iure et fugiat ab accusamus saepe et."
},
"url": {
"en": "http://hettinger.com/consequatur-repellendus-dignissimos-illo-sed-rerum-quis-rerum-atque.html"
}
}
},
{
"id": 17,
"name": "Leta Douglas",
"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": "Deserunt facilis perferendis saepe quaerat nisi et impedit perferendis ratione."
},
"description": {
"en": "Assumenda cumque est doloremque animi rerum ipsa consectetur. Consectetur fugit facere molestiae quaerat ut. In assumenda nulla sunt et iure maiores rerum."
},
"url": {
"en": "https://rodriguez.com/omnis-nobis-quidem-vel-nihil-tenetur.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
15,
17,
10
]
},
{
"name": "...",
"category_ids": [
16,
19,
13
]
},
{
"name": "...",
"category_ids": [
15,
10,
19
]
}
],
"hours": {
"open": [
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
},
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
},
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
}
],
"takeout": [
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
},
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
},
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
}
],
"delivery": [
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
},
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
},
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
}
],
"latch": [
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
},
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
},
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
}
]
},
"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"
}
]
}When returned in a response.
{
"id": 11,
"name": "Dr. Declan Kemmer",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"offers": [
{
"id": 10,
"name": "...",
"items": [
{
"type": "product",
"item_id": 19,
"percentage": 16,
"minimum": 15
},
{
"type": "product",
"item_id": 13,
"percentage": 12,
"minimum": 16
},
{
"type": "product",
"item_id": 18,
"percentage": 15,
"minimum": 11
}
]
},
{
"id": 17,
"name": "...",
"items": [
{
"type": "product",
"item_id": 19,
"percentage": 18,
"minimum": 10
},
{
"type": "product",
"item_id": 17,
"percentage": 14,
"minimum": 10
},
{
"type": "product",
"item_id": 10,
"percentage": 13,
"minimum": 17
}
]
},
{
"id": 19,
"name": "...",
"items": [
{
"type": "product",
"item_id": 19,
"percentage": 17,
"minimum": 14
},
{
"type": "product",
"item_id": 16,
"percentage": 12,
"minimum": 18
},
{
"type": "product",
"item_id": 12,
"percentage": 13,
"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": true
}
},
"allow_comments": false,
"allow_orders": false,
"delivery_use_intervals": true,
"categories": [
{
"id": 16,
"name": "Prof. Alvina Sauer IV",
"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": "Temporibus magni quae quos harum et harum ipsa."
},
"description": {
"en": "Ab molestias optio veniam facere sequi a distinctio. Ut quia reprehenderit sed. Cupiditate ipsum hic temporibus consequatur et sequi."
},
"url": {
"en": "https://www.braun.net/voluptatem-autem-quis-eos-aut-nostrum"
}
}
},
{
"id": 15,
"name": "Hilario Schimmel DVM",
"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": "Repellat voluptatem vel at eius veritatis et repellat quidem."
},
"description": {
"en": "Veniam eos beatae sunt. Modi et in vel eum enim. Assumenda officiis tenetur atque iure excepturi esse ea totam."
},
"url": {
"en": "http://kemmer.com/reprehenderit-tenetur-dolores-qui-veniam-debitis"
}
}
},
{
"id": 14,
"name": "Dr. Alberta Stamm",
"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": "Unde ullam dicta sint aperiam voluptate fugit culpa ut."
},
"description": {
"en": "Harum distinctio vel dolores eveniet enim eligendi. Est laudantium quo in voluptatem veritatis consequatur fugit."
},
"url": {
"en": "http://www.homenick.com/ut-quidem-dolorem-voluptate-reiciendis-occaecati-omnis-dignissimos"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
10,
17,
19
]
},
{
"name": "...",
"category_ids": [
11,
14,
10
]
},
{
"name": "...",
"category_ids": [
10,
15,
16
]
}
],
"hours": {
"open": [
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
},
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
},
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
}
],
"takeout": [
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
},
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
},
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
}
],
"delivery": [
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
},
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
},
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
}
],
"latch": [
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
},
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
},
{
"start": 1,
"end": 1,
"times": [
"...",
"...",
"..."
]
}
]
},
"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"
}
]
}