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": "Lyda Kohler",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"offers": [
{
"id": 16,
"name": "...",
"items": [
{
"type": "product",
"item_id": 12,
"percentage": 19,
"minimum": 17
},
{
"type": "product",
"item_id": 15,
"percentage": 13,
"minimum": 12
},
{
"type": "product",
"item_id": 16,
"percentage": 12,
"minimum": 17
}
]
},
{
"id": 12,
"name": "...",
"items": [
{
"type": "product",
"item_id": 11,
"percentage": 14,
"minimum": 18
},
{
"type": "product",
"item_id": 19,
"percentage": 19,
"minimum": 13
},
{
"type": "product",
"item_id": 11,
"percentage": 16,
"minimum": 15
}
]
},
{
"id": 15,
"name": "...",
"items": [
{
"type": "product",
"item_id": 15,
"percentage": 19,
"minimum": 15
},
{
"type": "product",
"item_id": 16,
"percentage": 17,
"minimum": 18
},
{
"type": "product",
"item_id": 16,
"percentage": 16,
"minimum": 15
}
]
}
],
"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": true,
"categories": [
{
"id": 11,
"name": "Dr. Lexus Bailey PhD",
"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": "Sed commodi eveniet molestias nobis vel molestiae qui animi iste."
},
"description": {
"en": "Sit consectetur qui ratione dolorum. In sunt ea vitae cumque quo aliquid velit. Vel voluptates reprehenderit temporibus doloribus ratione quam eum animi."
},
"url": {
"en": "http://www.herzog.org/perspiciatis-voluptatem-eius-ipsum-natus-aut"
}
}
},
{
"id": 13,
"name": "Lois Williamson",
"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": "Hic et consequatur porro esse esse earum sint."
},
"description": {
"en": "Iste modi asperiores distinctio voluptatum animi qui quam. Omnis dolore suscipit doloribus commodi est. Libero facilis pariatur eum."
},
"url": {
"en": "http://www.koepp.net/"
}
}
},
{
"id": 15,
"name": "Miss Rachel Wisozk 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": "Veritatis qui dolore in culpa magni sed."
},
"description": {
"en": "Exercitationem voluptatibus impedit repellendus quia consectetur. Nesciunt quas non saepe totam qui cum illo. Voluptates quia eum consequatur suscipit. Quia qui eos ratione itaque sunt."
},
"url": {
"en": "http://goodwin.com/voluptate-illo-facere-sit-labore.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
12,
19,
13
]
},
{
"name": "...",
"category_ids": [
14,
12,
13
]
},
{
"name": "...",
"category_ids": [
17,
15,
12
]
}
]
}When returned in a response.
{
"id": 19,
"name": "Ms. Adrianna Turner II",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"offers": [
{
"id": 17,
"name": "...",
"items": [
{
"type": "product",
"item_id": 18,
"percentage": 19,
"minimum": 10
},
{
"type": "product",
"item_id": 13,
"percentage": 11,
"minimum": 14
},
{
"type": "product",
"item_id": 12,
"percentage": 11,
"minimum": 13
}
]
},
{
"id": 18,
"name": "...",
"items": [
{
"type": "product",
"item_id": 10,
"percentage": 10,
"minimum": 16
},
{
"type": "product",
"item_id": 18,
"percentage": 13,
"minimum": 10
},
{
"type": "product",
"item_id": 17,
"percentage": 14,
"minimum": 18
}
]
},
{
"id": 19,
"name": "...",
"items": [
{
"type": "product",
"item_id": 19,
"percentage": 15,
"minimum": 10
},
{
"type": "product",
"item_id": 18,
"percentage": 19,
"minimum": 18
},
{
"type": "product",
"item_id": 14,
"percentage": 16,
"minimum": 14
}
]
}
],
"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": "Coleman Dicki",
"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": "Eos id laboriosam explicabo ex voluptates officia iusto."
},
"description": {
"en": "Velit quasi architecto quam illo ipsa quam architecto ratione. Tenetur officia corporis omnis fugit et aliquam. Molestias nihil exercitationem tempora consectetur nihil minima reiciendis."
},
"url": {
"en": "http://www.dach.com/ad-ut-autem-accusamus-et-veniam-qui-deleniti-temporibus"
}
}
},
{
"id": 14,
"name": "Margarita 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": true
},
"seo": {
"title": {
"en": "Perspiciatis libero temporibus commodi minus aut quia porro."
},
"description": {
"en": "Sint exercitationem dolor ratione voluptatum temporibus repellendus eos. Facilis libero eligendi unde nesciunt ex fugit."
},
"url": {
"en": "http://thiel.net/velit-debitis-cupiditate-voluptatem-aliquam"
}
}
},
{
"id": 18,
"name": "Anabel Wolff",
"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": "Recusandae autem illum quisquam non architecto amet aspernatur veritatis fuga aut."
},
"description": {
"en": "Explicabo et adipisci molestiae veniam aliquam dignissimos. Nobis animi voluptatem aut natus et. Quia voluptatem at sunt et omnis. Voluptatum consectetur perspiciatis sapiente cumque esse labore."
},
"url": {
"en": "http://www.bradtke.biz/illo-adipisci-autem-placeat-non-est-fugit"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
10,
11,
16
]
},
{
"name": "...",
"category_ids": [
18,
16,
16
]
},
{
"name": "...",
"category_ids": [
15,
15,
15
]
}
]
}