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": "Maximus Strosin",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"offers": [
{
"id": 16,
"name": "...",
"items": [
{
"type": "product",
"item_id": 19,
"percentage": 10,
"minimum": 19
},
{
"type": "product",
"item_id": 19,
"percentage": 11,
"minimum": 16
},
{
"type": "product",
"item_id": 17,
"percentage": 17,
"minimum": 13
}
]
},
{
"id": 15,
"name": "...",
"items": [
{
"type": "product",
"item_id": 11,
"percentage": 15,
"minimum": 14
},
{
"type": "product",
"item_id": 14,
"percentage": 17,
"minimum": 12
},
{
"type": "product",
"item_id": 14,
"percentage": 18,
"minimum": 16
}
]
},
{
"id": 13,
"name": "...",
"items": [
{
"type": "product",
"item_id": 19,
"percentage": 17,
"minimum": 15
},
{
"type": "product",
"item_id": 11,
"percentage": 18,
"minimum": 13
},
{
"type": "product",
"item_id": 19,
"percentage": 16,
"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": false
}
},
"allow_comments": true,
"allow_orders": true,
"delivery_use_intervals": true,
"categories": [
{
"id": 15,
"name": "Deja Yundt PhD",
"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": "Velit est consectetur provident itaque eum."
},
"description": {
"en": "Ab earum consequatur deleniti illum velit ut impedit. Consequatur ad expedita exercitationem dolorum nulla. Ratione rem odit ex asperiores commodi placeat repudiandae omnis."
},
"url": {
"en": "http://bruen.org/ipsa-illo-at-voluptas-veritatis-sit-iste"
}
}
},
{
"id": 14,
"name": "Wilton Keeling",
"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": "Omnis dicta qui voluptas in qui quasi vitae et rerum."
},
"description": {
"en": "Iusto vero molestiae vel dolorem velit provident. Quidem et consectetur voluptatibus."
},
"url": {
"en": "http://kutch.com/rerum-deleniti-omnis-quasi-voluptas-enim.html"
}
}
},
{
"id": 17,
"name": "Adrian Jerde",
"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": "Quam veniam sit distinctio aliquid culpa quia saepe et omnis dolores odio."
},
"description": {
"en": "Pariatur delectus labore esse perferendis dignissimos ut dignissimos earum. Saepe aut maiores rem ut fugit aut sed. Impedit quod ut ea cumque. Et enim quos aliquam culpa et est praesentium."
},
"url": {
"en": "https://www.doyle.com/reprehenderit-esse-ipsum-aut-perferendis-voluptatem-ut"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
15,
10,
18
]
},
{
"name": "...",
"category_ids": [
13,
15,
12
]
},
{
"name": "...",
"category_ids": [
16,
14,
18
]
}
],
"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": 12,
"name": "Jermain Schinner",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"offers": [
{
"id": 11,
"name": "...",
"items": [
{
"type": "product",
"item_id": 14,
"percentage": 19,
"minimum": 15
},
{
"type": "product",
"item_id": 12,
"percentage": 10,
"minimum": 11
},
{
"type": "product",
"item_id": 13,
"percentage": 14,
"minimum": 17
}
]
},
{
"id": 17,
"name": "...",
"items": [
{
"type": "product",
"item_id": 18,
"percentage": 15,
"minimum": 15
},
{
"type": "product",
"item_id": 13,
"percentage": 17,
"minimum": 12
},
{
"type": "product",
"item_id": 15,
"percentage": 17,
"minimum": 12
}
]
},
{
"id": 14,
"name": "...",
"items": [
{
"type": "product",
"item_id": 11,
"percentage": 12,
"minimum": 14
},
{
"type": "product",
"item_id": 13,
"percentage": 11,
"minimum": 18
},
{
"type": "product",
"item_id": 10,
"percentage": 16,
"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": false,
"allow_orders": true,
"delivery_use_intervals": false,
"categories": [
{
"id": 19,
"name": "Mr. Keaton Russel",
"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": "Quasi et facere ipsa amet non velit non qui quaerat magni ut."
},
"description": {
"en": "Fuga voluptatem necessitatibus quaerat quos. Earum dolores nulla maxime et in impedit. Repudiandae reprehenderit quis aut officiis adipisci est. Doloribus cum et porro natus et provident."
},
"url": {
"en": "http://www.rau.com/eaque-fugit-atque-numquam-fuga-fuga"
}
}
},
{
"id": 12,
"name": "Mr. Chester Zulauf V",
"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": "Facilis quod est qui eos nemo quasi enim ut nisi aut deserunt."
},
"description": {
"en": "Doloribus velit amet aut voluptas esse. Sint minus culpa in consequatur vero aliquid et qui. Rerum fugit nemo vero magnam vero."
},
"url": {
"en": "http://treutel.info/illo-debitis-sunt-qui"
}
}
},
{
"id": 17,
"name": "Prof. Loren Goldner 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": false
},
"seo": {
"title": {
"en": "Iste corporis amet voluptatem aut corrupti possimus tenetur commodi."
},
"description": {
"en": "Adipisci ipsam nemo a aliquam. Hic id repellat cumque harum magni laboriosam omnis. Optio sed non sunt fugit tempore et ad."
},
"url": {
"en": "http://sawayn.biz/eum-est-ad-enim.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
14,
10,
17
]
},
{
"name": "...",
"category_ids": [
19,
13,
16
]
},
{
"name": "...",
"category_ids": [
19,
12,
12
]
}
],
"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"
}
]
}