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. |
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. |
When used inside a request.
{
"id": 15,
"name": "Prof. Madison Lindgren",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"offers": [
{
"id": 19,
"name": "...",
"items": [
{
"type": "product",
"item_id": 18,
"percentage": 19,
"minimum": 11
},
{
"type": "product",
"item_id": 15,
"percentage": 16,
"minimum": 15
},
{
"type": "product",
"item_id": 19,
"percentage": 11,
"minimum": 13
}
]
},
{
"id": 19,
"name": "...",
"items": [
{
"type": "product",
"item_id": 13,
"percentage": 14,
"minimum": 15
},
{
"type": "product",
"item_id": 16,
"percentage": 19,
"minimum": 10
},
{
"type": "product",
"item_id": 17,
"percentage": 15,
"minimum": 11
}
]
},
{
"id": 10,
"name": "...",
"items": [
{
"type": "product",
"item_id": 12,
"percentage": 18,
"minimum": 12
},
{
"type": "product",
"item_id": 16,
"percentage": 12,
"minimum": 15
},
{
"type": "product",
"item_id": 15,
"percentage": 18,
"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": true,
"allow_orders": true,
"delivery_use_intervals": true,
"categories": [
{
"id": 12,
"name": "Riley Spinka",
"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": "Ut qui nam molestiae ullam nesciunt."
},
"description": {
"en": "Aperiam qui ab vel est. Libero dolore voluptatem ut."
},
"url": {
"en": "https://heathcote.info/placeat-aut-autem-eius-non.html"
}
}
},
{
"id": 19,
"name": "Justus Little",
"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": "Magnam ad sit et libero voluptate."
},
"description": {
"en": "Voluptas non quae voluptas totam est placeat et possimus. Consequuntur corrupti soluta ab sunt amet id eos. Quaerat sunt provident neque iste iusto iure a eos."
},
"url": {
"en": "http://www.ohara.com/illum-iusto-reprehenderit-occaecati-quo.html"
}
}
},
{
"id": 12,
"name": "German McKenzie",
"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": "Error eaque voluptatibus dolorem sit facere animi et sit neque."
},
"description": {
"en": "Et est eligendi a tempore tempora doloribus recusandae. Iste reprehenderit soluta unde delectus. Enim tempora ex necessitatibus fugit numquam. Molestiae praesentium sit qui quod."
},
"url": {
"en": "http://www.torphy.net/perspiciatis-et-rerum-unde-aliquam-dignissimos-similique.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
15,
19,
19
]
},
{
"name": "...",
"category_ids": [
12,
15,
14
]
},
{
"name": "...",
"category_ids": [
15,
19,
18
]
}
]
}When returned in a response.
{
"id": 19,
"name": "Leone Block",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"offers": [
{
"id": 14,
"name": "...",
"items": [
{
"type": "product",
"item_id": 16,
"percentage": 18,
"minimum": 11
},
{
"type": "product",
"item_id": 18,
"percentage": 13,
"minimum": 17
},
{
"type": "product",
"item_id": 17,
"percentage": 11,
"minimum": 13
}
]
},
{
"id": 16,
"name": "...",
"items": [
{
"type": "product",
"item_id": 18,
"percentage": 16,
"minimum": 19
},
{
"type": "product",
"item_id": 13,
"percentage": 13,
"minimum": 16
},
{
"type": "product",
"item_id": 11,
"percentage": 17,
"minimum": 16
}
]
},
{
"id": 15,
"name": "...",
"items": [
{
"type": "product",
"item_id": 15,
"percentage": 19,
"minimum": 18
},
{
"type": "product",
"item_id": 12,
"percentage": 19,
"minimum": 17
},
{
"type": "product",
"item_id": 18,
"percentage": 17,
"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": true,
"allow_orders": true,
"delivery_use_intervals": false,
"categories": [
{
"id": 17,
"name": "Camron Hegmann",
"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": "Iure hic molestiae et error eaque voluptate officiis saepe et."
},
"description": {
"en": "Facilis odio est et libero. Illo eos eveniet earum eius qui dolor perspiciatis non. Qui quia quia perferendis sunt maxime possimus. Dolor suscipit reiciendis mollitia dolorem et aliquid eum fugit."
},
"url": {
"en": "http://greenfelder.net/provident-reprehenderit-fuga-dignissimos-voluptatem-impedit-odit-perferendis.html"
}
}
},
{
"id": 10,
"name": "Marquis Paucek",
"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": "Quis eum est alias nulla mollitia magni et voluptas et ducimus."
},
"description": {
"en": "Molestiae dignissimos ex consequatur harum facere. Asperiores recusandae iusto nulla sequi in rerum culpa. Eaque rem eius voluptatem et sed consequuntur nulla."
},
"url": {
"en": "http://www.littel.com/"
}
}
},
{
"id": 14,
"name": "Moses Jakubowski",
"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": "Et sed quibusdam aperiam et eum odio natus natus sunt."
},
"description": {
"en": "Nostrum ea qui aut veritatis. Consequatur eius eveniet assumenda dolorum. Id non sit tempora similique dolor totam distinctio."
},
"url": {
"en": "http://howell.info/cum-et-odit-quasi-facilis-est-sint-quae-ipsam"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
18,
18,
13
]
},
{
"name": "...",
"category_ids": [
18,
13,
11
]
},
{
"name": "...",
"category_ids": [
14,
14,
11
]
}
]
}