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. |
| 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. |
| currency | Currency | 3 letter ISO 4217 currency name (string) |
When used inside a request.
{
"id": 11,
"name": "Elsa Krajcik II",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"offers": [
{
"id": 15,
"name": "...",
"items": [
{
"type": "product",
"item_id": 18,
"percentage": 15,
"minimum": 12
},
{
"type": "product",
"item_id": 18,
"percentage": 14,
"minimum": 12
},
{
"type": "product",
"item_id": 17,
"percentage": 12,
"minimum": 14
}
]
},
{
"id": 15,
"name": "...",
"items": [
{
"type": "product",
"item_id": 13,
"percentage": 12,
"minimum": 13
},
{
"type": "product",
"item_id": 17,
"percentage": 18,
"minimum": 19
},
{
"type": "product",
"item_id": 14,
"percentage": 14,
"minimum": 16
}
]
},
{
"id": 17,
"name": "...",
"items": [
{
"type": "product",
"item_id": 17,
"percentage": 16,
"minimum": 18
},
{
"type": "product",
"item_id": 18,
"percentage": 17,
"minimum": 17
},
{
"type": "product",
"item_id": 10,
"percentage": 19,
"minimum": 19
}
]
}
],
"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": true,
"categories": [
{
"id": 11,
"name": "Prof. Eric Walker 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": "Sed in ipsam nam ut et."
},
"description": {
"en": "Sed temporibus voluptas aut. Ut et nemo nam ducimus dolorem quasi doloremque."
},
"url": {
"en": "http://cummerata.com/"
}
}
},
{
"id": 17,
"name": "Bertrand Legros",
"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 natus iure repellendus eligendi ipsum voluptatem aut molestiae dolore."
},
"description": {
"en": "Eius aut molestiae quia dolore ea a officiis nihil. Explicabo quis sit est autem aut asperiores facere. Et consequuntur praesentium nemo nobis quos blanditiis."
},
"url": {
"en": "http://www.windler.com/enim-omnis-harum-autem-nemo.html"
}
}
},
{
"id": 13,
"name": "Estelle Morissette",
"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": "Cum ipsum pariatur dolorem nulla voluptate et voluptatum qui."
},
"description": {
"en": "Dicta laboriosam placeat non expedita enim illum rerum. Dignissimos maxime illo sapiente eos tempora. Error ipsum accusantium fuga eius."
},
"url": {
"en": "http://www.wisozk.com/sunt-repellendus-provident-possimus-et-officia-in.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
15,
14,
10
]
},
{
"name": "...",
"category_ids": [
13,
17,
10
]
},
{
"name": "...",
"category_ids": [
10,
16,
11
]
}
],
"currency": "EUR"
}When returned in a response.
{
"id": 15,
"name": "Dr. Sven Stoltenberg",
"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": 11,
"percentage": 12,
"minimum": 18
},
{
"type": "product",
"item_id": 18,
"percentage": 12,
"minimum": 15
},
{
"type": "product",
"item_id": 14,
"percentage": 16,
"minimum": 17
}
]
},
{
"id": 10,
"name": "...",
"items": [
{
"type": "product",
"item_id": 19,
"percentage": 17,
"minimum": 18
},
{
"type": "product",
"item_id": 10,
"percentage": 13,
"minimum": 17
},
{
"type": "product",
"item_id": 18,
"percentage": 15,
"minimum": 18
}
]
},
{
"id": 15,
"name": "...",
"items": [
{
"type": "product",
"item_id": 14,
"percentage": 19,
"minimum": 17
},
{
"type": "product",
"item_id": 11,
"percentage": 11,
"minimum": 14
},
{
"type": "product",
"item_id": 10,
"percentage": 16,
"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": false
}
},
"allow_comments": true,
"allow_orders": true,
"delivery_use_intervals": false,
"categories": [
{
"id": 12,
"name": "Carol Kassulke",
"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": "Quam quisquam nemo sit voluptas."
},
"description": {
"en": "Doloribus asperiores illo qui error nihil architecto. Unde sint nisi quis nisi et eos. Ab voluptas magnam eos et. Et autem vitae reiciendis quia."
},
"url": {
"en": "http://www.feeney.com/adipisci-qui-explicabo-sequi-maiores-et-illo"
}
}
},
{
"id": 19,
"name": "Reba Lynch",
"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": "Saepe pariatur excepturi beatae dignissimos et necessitatibus repellendus."
},
"description": {
"en": "Omnis ipsum maiores provident. Eaque molestias temporibus fugit esse unde. Beatae cumque qui error architecto doloribus minima dolorem nam."
},
"url": {
"en": "http://www.feeney.info/"
}
}
},
{
"id": 12,
"name": "Johnathan Koss",
"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": "Cum quia praesentium nisi est aut voluptatem."
},
"description": {
"en": "Officia quod est hic quia. Earum veniam ut rerum voluptatem nemo esse quisquam. Aliquam consequatur non voluptates numquam quo voluptas quo."
},
"url": {
"en": "http://schroeder.info/explicabo-eligendi-est-laudantium-quis-aperiam"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
14,
18,
12
]
},
{
"name": "...",
"category_ids": [
18,
10,
10
]
},
{
"name": "...",
"category_ids": [
14,
18,
11
]
}
],
"currency": "EUR"
}