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": 11,
"name": "Desiree Weimann",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"offers": [
{
"id": 17,
"name": "...",
"items": [
{
"type": "product",
"item_id": 18,
"percentage": 16,
"minimum": 11
},
{
"type": "product",
"item_id": 10,
"percentage": 14,
"minimum": 17
},
{
"type": "product",
"item_id": 16,
"percentage": 18,
"minimum": 14
}
]
},
{
"id": 13,
"name": "...",
"items": [
{
"type": "product",
"item_id": 10,
"percentage": 17,
"minimum": 15
},
{
"type": "product",
"item_id": 15,
"percentage": 17,
"minimum": 12
},
{
"type": "product",
"item_id": 19,
"percentage": 10,
"minimum": 14
}
]
},
{
"id": 19,
"name": "...",
"items": [
{
"type": "product",
"item_id": 11,
"percentage": 18,
"minimum": 16
},
{
"type": "product",
"item_id": 15,
"percentage": 15,
"minimum": 16
},
{
"type": "product",
"item_id": 16,
"percentage": 14,
"minimum": 10
}
]
}
],
"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": "Willie Gibson",
"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": "Vitae labore architecto exercitationem qui qui suscipit mollitia."
},
"description": {
"en": "Labore similique ea omnis ducimus. Cumque officia odio et qui rem nam. Libero et quis et ut laboriosam est provident."
},
"url": {
"en": "http://jones.biz/sit-libero-eius-distinctio-excepturi-minus-quaerat-nobis.html"
}
}
},
{
"id": 12,
"name": "Myron Brakus",
"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 qui mollitia sed ab qui facere assumenda minus dolorem est."
},
"description": {
"en": "Hic soluta at pariatur inventore quasi rem quaerat. Dolor sit quisquam et dolores."
},
"url": {
"en": "http://www.lind.com/"
}
}
},
{
"id": 10,
"name": "Dr. Kenya Ortiz II",
"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": "Dolorem tempora vel quis hic asperiores."
},
"description": {
"en": "Et ab dolores omnis ratione quisquam numquam. Et iusto rem laboriosam est aut vel. Qui quia atque provident."
},
"url": {
"en": "https://www.rempel.net/ab-minus-vitae-nostrum-libero-occaecati-delectus"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
18,
14,
13
]
},
{
"name": "...",
"category_ids": [
15,
14,
11
]
},
{
"name": "...",
"category_ids": [
11,
11,
18
]
}
]
}When returned in a response.
{
"id": 19,
"name": "Ms. Ozella Glover",
"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": 16,
"percentage": 10,
"minimum": 14
},
{
"type": "product",
"item_id": 13,
"percentage": 14,
"minimum": 13
},
{
"type": "product",
"item_id": 19,
"percentage": 17,
"minimum": 17
}
]
},
{
"id": 14,
"name": "...",
"items": [
{
"type": "product",
"item_id": 10,
"percentage": 13,
"minimum": 15
},
{
"type": "product",
"item_id": 11,
"percentage": 10,
"minimum": 19
},
{
"type": "product",
"item_id": 10,
"percentage": 10,
"minimum": 15
}
]
},
{
"id": 15,
"name": "...",
"items": [
{
"type": "product",
"item_id": 12,
"percentage": 11,
"minimum": 14
},
{
"type": "product",
"item_id": 19,
"percentage": 15,
"minimum": 13
},
{
"type": "product",
"item_id": 19,
"percentage": 13,
"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": false,
"delivery_use_intervals": true,
"categories": [
{
"id": 15,
"name": "Alfredo Fahey",
"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": "Culpa unde quas id nulla accusantium quibusdam."
},
"description": {
"en": "Molestiae fugit reiciendis sunt nulla. Sunt quae necessitatibus rerum quisquam expedita maiores voluptate dicta."
},
"url": {
"en": "http://adams.net/modi-porro-quia-sunt-exercitationem-error"
}
}
},
{
"id": 11,
"name": "Emely Mueller",
"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": "Laudantium excepturi inventore quae esse nostrum delectus odit."
},
"description": {
"en": "Earum ea voluptatum aut recusandae. Et magnam pariatur eum in itaque accusamus id. Non excepturi beatae asperiores eum quia ipsam. Sequi officia alias et quae fugiat. Sequi dolorem id labore."
},
"url": {
"en": "http://koss.com/"
}
}
},
{
"id": 15,
"name": "Helga Dach",
"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": "Placeat ut minima voluptas possimus velit saepe quas."
},
"description": {
"en": "Quo est nam et. Molestias labore illum libero animi. Architecto est nihil repudiandae dolore ut. Ut qui repudiandae nihil sed ullam quae repellat nobis."
},
"url": {
"en": "http://www.watsica.org/"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
12,
17,
10
]
},
{
"name": "...",
"category_ids": [
14,
10,
17
]
},
{
"name": "...",
"category_ids": [
15,
19,
10
]
}
]
}