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 |
| 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 | 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 |
| currency | Currency | 3 letter ISO 4217 currency name (string) |
When used inside a request.
{
"id": 15,
"name": "Kristina Kuphal",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"offers": [
{
"id": 17,
"name": "...",
"items": [
{
"type": "product",
"item_id": 17,
"percentage": 18,
"minimum": 18
},
{
"type": "product",
"item_id": 13,
"percentage": 15,
"minimum": 16
},
{
"type": "product",
"item_id": 17,
"percentage": 17,
"minimum": 11
}
]
},
{
"id": 17,
"name": "...",
"items": [
{
"type": "product",
"item_id": 12,
"percentage": 10,
"minimum": 19
},
{
"type": "product",
"item_id": 12,
"percentage": 17,
"minimum": 14
},
{
"type": "product",
"item_id": 17,
"percentage": 19,
"minimum": 19
}
]
},
{
"id": 17,
"name": "...",
"items": [
{
"type": "product",
"item_id": 15,
"percentage": 15,
"minimum": 11
},
{
"type": "product",
"item_id": 12,
"percentage": 12,
"minimum": 19
},
{
"type": "product",
"item_id": 10,
"percentage": 16,
"minimum": 17
}
]
}
],
"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": 12,
"name": "Ms. Selina 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": true
},
"seo": {
"title": {
"en": "Voluptatem vel voluptatum exercitationem velit ut aut et."
},
"description": {
"en": "Dicta dolor eaque deserunt blanditiis enim laboriosam quas. Tempore optio suscipit pariatur deserunt rem. Nam sunt dolor officiis dolore provident."
},
"url": {
"en": "http://krajcik.com/quisquam-vero-aliquam-veniam-et-dolorem-excepturi-facere-et"
}
}
},
{
"id": 18,
"name": "Adelle Schneider",
"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": "Sunt exercitationem ipsa odio earum quis dicta dolores cum sit."
},
"description": {
"en": "Fugiat nihil voluptatem rerum. Eum ipsam at aperiam tenetur. Placeat qui libero perferendis eveniet molestias earum. Qui in molestiae omnis dolorem."
},
"url": {
"en": "http://runolfsdottir.info/sed-est-nisi-ea-est-sint-laudantium-consequatur-aliquam"
}
}
},
{
"id": 10,
"name": "Dr. Dylan Bradtke",
"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": "Sint aperiam non dolores possimus nihil adipisci accusantium dolor earum."
},
"description": {
"en": "Et labore itaque rerum velit adipisci dolor necessitatibus. Laudantium sit laudantium recusandae nostrum inventore praesentium quia."
},
"url": {
"en": "http://quitzon.info/ut-sit-in-consequatur-illo-quo-et-est"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
12,
14,
18
]
},
{
"name": "...",
"category_ids": [
16,
14,
10
]
},
{
"name": "...",
"category_ids": [
11,
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"
}
],
"currency": "EUR"
}When returned in a response.
{
"id": 18,
"name": "Granville Barrows I",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"offers": [
{
"id": 16,
"name": "...",
"items": [
{
"type": "product",
"item_id": 16,
"percentage": 18,
"minimum": 14
},
{
"type": "product",
"item_id": 18,
"percentage": 18,
"minimum": 11
},
{
"type": "product",
"item_id": 11,
"percentage": 14,
"minimum": 13
}
]
},
{
"id": 12,
"name": "...",
"items": [
{
"type": "product",
"item_id": 12,
"percentage": 10,
"minimum": 15
},
{
"type": "product",
"item_id": 14,
"percentage": 13,
"minimum": 19
},
{
"type": "product",
"item_id": 17,
"percentage": 15,
"minimum": 14
}
]
},
{
"id": 17,
"name": "...",
"items": [
{
"type": "product",
"item_id": 18,
"percentage": 18,
"minimum": 15
},
{
"type": "product",
"item_id": 11,
"percentage": 13,
"minimum": 15
},
{
"type": "product",
"item_id": 14,
"percentage": 12,
"minimum": 17
}
]
}
],
"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": true,
"categories": [
{
"id": 18,
"name": "Prof. Agustin O'Reilly 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": false
},
"seo": {
"title": {
"en": "Iste aut eius velit suscipit sint cum beatae ullam quasi."
},
"description": {
"en": "Maiores enim explicabo at cupiditate distinctio velit autem delectus. Sit culpa et voluptatem numquam eum et. Animi quidem in voluptatem error a. Sunt voluptas quaerat quibusdam sit."
},
"url": {
"en": "http://www.spinka.com/tempora-sit-velit-ea-laudantium-autem-ut-asperiores.html"
}
}
},
{
"id": 11,
"name": "Ms. Rosanna Funk",
"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": "Facilis et doloremque molestias blanditiis."
},
"description": {
"en": "Voluptatem nesciunt ducimus omnis at. Ad voluptas eum libero omnis deserunt hic illo. Quis assumenda placeat rem ab id quidem officiis. Sit sed at quidem deleniti atque quod dignissimos."
},
"url": {
"en": "http://oconnell.com/debitis-libero-maiores-neque-veniam"
}
}
},
{
"id": 10,
"name": "Glenna Farrell 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": false
},
"seo": {
"title": {
"en": "Aperiam id doloribus tenetur minima officiis perferendis."
},
"description": {
"en": "Incidunt rerum tempore repudiandae quaerat. Facilis nesciunt ullam sapiente assumenda eaque quis qui sunt."
},
"url": {
"en": "http://www.purdy.com/quibusdam-laboriosam-quis-qui-omnis.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
12,
11,
15
]
},
{
"name": "...",
"category_ids": [
17,
13,
17
]
},
{
"name": "...",
"category_ids": [
19,
15,
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"
}
],
"currency": "EUR"
}