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": "Miss Selina Rutherford IV",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"offers": [
{
"id": 14,
"name": "...",
"items": [
{
"type": "product",
"item_id": 13,
"percentage": 19,
"minimum": 16
},
{
"type": "product",
"item_id": 15,
"percentage": 14,
"minimum": 12
},
{
"type": "product",
"item_id": 18,
"percentage": 17,
"minimum": 15
}
]
},
{
"id": 13,
"name": "...",
"items": [
{
"type": "product",
"item_id": 12,
"percentage": 10,
"minimum": 15
},
{
"type": "product",
"item_id": 18,
"percentage": 10,
"minimum": 14
},
{
"type": "product",
"item_id": 17,
"percentage": 15,
"minimum": 18
}
]
},
{
"id": 12,
"name": "...",
"items": [
{
"type": "product",
"item_id": 13,
"percentage": 15,
"minimum": 19
},
{
"type": "product",
"item_id": 12,
"percentage": 10,
"minimum": 14
},
{
"type": "product",
"item_id": 13,
"percentage": 16,
"minimum": 18
}
]
}
],
"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": true,
"categories": [
{
"id": 11,
"name": "Erling Jacobs",
"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": "Ut veniam ipsum saepe doloremque enim provident consequatur quo nihil."
},
"description": {
"en": "Dolore vel sequi necessitatibus cupiditate nulla asperiores sed. Et consequuntur dolorem quae dolorem. Sit nisi asperiores voluptas nostrum."
},
"url": {
"en": "https://www.jenkins.com/suscipit-laboriosam-id-incidunt-recusandae-maiores-et-corporis"
}
}
},
{
"id": 11,
"name": "Ewell Howe",
"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": "Sit ex necessitatibus hic autem magni aliquid."
},
"description": {
"en": "Maiores consequatur corporis et corrupti perferendis. Et consequatur et provident. Adipisci itaque dolorum est aliquid deserunt fugiat ab."
},
"url": {
"en": "http://heathcote.com/"
}
}
},
{
"id": 10,
"name": "Jazlyn Greenfelder 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": "Error consequatur impedit numquam et dolor nam iste laboriosam."
},
"description": {
"en": "Nobis deserunt maxime aliquid id non voluptatem. Ut nihil voluptatibus amet reprehenderit. Porro quibusdam ex odit in."
},
"url": {
"en": "http://anderson.com/ut-et-sed-iusto-est-et-optio-cupiditate"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
11,
15,
14
]
},
{
"name": "...",
"category_ids": [
16,
17,
15
]
},
{
"name": "...",
"category_ids": [
14,
16,
13
]
}
],
"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": 14,
"name": "Curt Gulgowski PhD",
"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": 19,
"percentage": 16,
"minimum": 16
},
{
"type": "product",
"item_id": 19,
"percentage": 17,
"minimum": 17
},
{
"type": "product",
"item_id": 12,
"percentage": 15,
"minimum": 19
}
]
},
{
"id": 17,
"name": "...",
"items": [
{
"type": "product",
"item_id": 19,
"percentage": 10,
"minimum": 10
},
{
"type": "product",
"item_id": 12,
"percentage": 14,
"minimum": 17
},
{
"type": "product",
"item_id": 14,
"percentage": 18,
"minimum": 11
}
]
},
{
"id": 10,
"name": "...",
"items": [
{
"type": "product",
"item_id": 11,
"percentage": 19,
"minimum": 13
},
{
"type": "product",
"item_id": 19,
"percentage": 14,
"minimum": 19
},
{
"type": "product",
"item_id": 13,
"percentage": 11,
"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": 10,
"name": "Mr. Boyd Mills",
"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": "Enim alias est vero quia."
},
"description": {
"en": "Voluptatem optio animi iusto aut officiis. Nostrum molestias et quae ad et consequatur. Voluptatem aut qui qui voluptas ut rem."
},
"url": {
"en": "http://www.bayer.org/id-eum-dolorem-quia-deleniti-quae-iste.html"
}
}
},
{
"id": 17,
"name": "Adriel Bogan",
"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": "Explicabo sint ipsum velit ut voluptatem in quo suscipit."
},
"description": {
"en": "Facilis accusamus consequatur sunt. Voluptas voluptatem harum in fugit labore voluptatem possimus. A voluptate totam eos quia placeat exercitationem."
},
"url": {
"en": "http://shanahan.com/laboriosam-aut-nesciunt-nemo-voluptatem-saepe-quia-tempore"
}
}
},
{
"id": 19,
"name": "Shane Quitzon",
"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": "Voluptates eum sed eos rerum quo voluptatem vel nihil suscipit nostrum."
},
"description": {
"en": "Veritatis ex quibusdam ea ex praesentium error. Repellat iste assumenda natus inventore ab sed maiores. Minus enim et sequi doloribus dolore. Recusandae explicabo occaecati aut facilis."
},
"url": {
"en": "http://www.steuber.com/molestias-est-ducimus-maxime-ratione-placeat-sint"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
13,
10,
14
]
},
{
"name": "...",
"category_ids": [
12,
16,
10
]
},
{
"name": "...",
"category_ids": [
11,
12,
11
]
}
],
"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"
}
]
}