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": 19,
"name": "Dr. Maida Boehm II",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"offers": [
{
"id": 18,
"name": "...",
"items": [
{
"type": "product",
"item_id": 13,
"percentage": 13,
"minimum": 16
},
{
"type": "product",
"item_id": 15,
"percentage": 15,
"minimum": 14
},
{
"type": "product",
"item_id": 18,
"percentage": 10,
"minimum": 12
}
]
},
{
"id": 19,
"name": "...",
"items": [
{
"type": "product",
"item_id": 15,
"percentage": 17,
"minimum": 12
},
{
"type": "product",
"item_id": 12,
"percentage": 14,
"minimum": 11
},
{
"type": "product",
"item_id": 11,
"percentage": 17,
"minimum": 19
}
]
},
{
"id": 15,
"name": "...",
"items": [
{
"type": "product",
"item_id": 12,
"percentage": 10,
"minimum": 10
},
{
"type": "product",
"item_id": 16,
"percentage": 17,
"minimum": 17
},
{
"type": "product",
"item_id": 15,
"percentage": 19,
"minimum": 11
}
]
}
],
"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": 18,
"name": "Salvador Yost",
"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": "Labore necessitatibus magnam voluptatem sed nesciunt."
},
"description": {
"en": "Ad maxime quia officiis non animi repellat. Unde nihil eos quis eos et quo ducimus. Quidem similique pariatur fuga autem. Quos eaque saepe molestiae nisi inventore."
},
"url": {
"en": "http://terry.com/vero-explicabo-consequatur-quis-blanditiis"
}
}
},
{
"id": 17,
"name": "Sasha Kuphal",
"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": "At repellat animi ratione voluptatem ut."
},
"description": {
"en": "Ad laboriosam hic in molestiae distinctio neque omnis doloremque. Ea est temporibus delectus ut deleniti nisi iusto. Hic assumenda officia in amet a ducimus."
},
"url": {
"en": "http://little.net/"
}
}
},
{
"id": 14,
"name": "Prof. Aric Roob 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": false
},
"seo": {
"title": {
"en": "Veniam ab itaque ipsum debitis et dolores nam voluptatem."
},
"description": {
"en": "Sit qui praesentium ex aliquam aut. Consequuntur cupiditate possimus voluptatem. Veniam quibusdam est qui aut."
},
"url": {
"en": "https://www.kerluke.com/cumque-vitae-nisi-sunt-id"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
14,
16,
17
]
},
{
"name": "...",
"category_ids": [
16,
15,
10
]
},
{
"name": "...",
"category_ids": [
15,
19,
14
]
}
],
"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": 19,
"name": "Aleen Williamson",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"offers": [
{
"id": 12,
"name": "...",
"items": [
{
"type": "product",
"item_id": 14,
"percentage": 15,
"minimum": 18
},
{
"type": "product",
"item_id": 17,
"percentage": 16,
"minimum": 18
},
{
"type": "product",
"item_id": 16,
"percentage": 15,
"minimum": 16
}
]
},
{
"id": 15,
"name": "...",
"items": [
{
"type": "product",
"item_id": 10,
"percentage": 19,
"minimum": 13
},
{
"type": "product",
"item_id": 18,
"percentage": 15,
"minimum": 14
},
{
"type": "product",
"item_id": 17,
"percentage": 16,
"minimum": 10
}
]
},
{
"id": 19,
"name": "...",
"items": [
{
"type": "product",
"item_id": 15,
"percentage": 17,
"minimum": 11
},
{
"type": "product",
"item_id": 18,
"percentage": 10,
"minimum": 17
},
{
"type": "product",
"item_id": 15,
"percentage": 10,
"minimum": 13
}
]
}
],
"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": true,
"delivery_use_intervals": false,
"categories": [
{
"id": 18,
"name": "Miss Gail Schaden 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": "Ad eveniet non necessitatibus quis aut est possimus dolore ut."
},
"description": {
"en": "Illum voluptatum saepe fugiat nesciunt rerum labore. In qui dolorum est. Culpa nisi recusandae dignissimos. Doloribus soluta quas consequatur rem."
},
"url": {
"en": "http://wilderman.com/occaecati-harum-dignissimos-quaerat-porro-aperiam-similique.html"
}
}
},
{
"id": 18,
"name": "Maybell Keebler",
"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": "Rem iure ut quia at at rem vel."
},
"description": {
"en": "Ut nulla et amet. Quod sit sint nobis nihil. Non ut illo quas voluptas ipsam eum repudiandae et. Sint officiis rerum ea fugit."
},
"url": {
"en": "http://medhurst.info/velit-quam-itaque-accusamus-voluptate-est"
}
}
},
{
"id": 13,
"name": "Marcelina Wilkinson",
"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": "Occaecati sit sequi quia molestiae et rerum aliquam molestiae id dolores."
},
"description": {
"en": "Et error adipisci in sint. Aut non placeat molestiae. Ipsam quasi sunt doloremque numquam adipisci sed omnis. Debitis veniam sed sit mollitia autem."
},
"url": {
"en": "http://www.wyman.com/"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
13,
18,
16
]
},
{
"name": "...",
"category_ids": [
18,
12,
14
]
},
{
"name": "...",
"category_ids": [
15,
18,
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"
}