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": 13,
"name": "Ettie Langworth",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"offers": [
{
"id": 16,
"name": "...",
"items": [
{
"type": "product",
"item_id": 13,
"percentage": 12,
"minimum": 10
},
{
"type": "product",
"item_id": 14,
"percentage": 11,
"minimum": 13
},
{
"type": "product",
"item_id": 15,
"percentage": 14,
"minimum": 18
}
]
},
{
"id": 16,
"name": "...",
"items": [
{
"type": "product",
"item_id": 16,
"percentage": 11,
"minimum": 18
},
{
"type": "product",
"item_id": 16,
"percentage": 11,
"minimum": 18
},
{
"type": "product",
"item_id": 17,
"percentage": 11,
"minimum": 19
}
]
},
{
"id": 19,
"name": "...",
"items": [
{
"type": "product",
"item_id": 18,
"percentage": 19,
"minimum": 12
},
{
"type": "product",
"item_id": 18,
"percentage": 17,
"minimum": 14
},
{
"type": "product",
"item_id": 13,
"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": true
}
},
"allow_comments": false,
"allow_orders": false,
"delivery_use_intervals": false,
"categories": [
{
"id": 12,
"name": "Angelita Goyette Jr.",
"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": "Et necessitatibus animi culpa qui laborum reiciendis."
},
"description": {
"en": "Aut dolor neque maxime. Quos repellat modi repellendus sed nisi qui et. Assumenda corrupti tempore esse et non assumenda dolore suscipit."
},
"url": {
"en": "http://www.reichel.com/"
}
}
},
{
"id": 15,
"name": "Mandy Runolfsdottir Jr.",
"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": "Molestiae et doloribus qui ullam repellendus magnam eaque eos."
},
"description": {
"en": "Ut ullam sunt veritatis hic debitis nulla. Labore modi sint nihil ipsam. Nemo placeat et nisi nobis at quidem vel. Neque qui itaque dolorem voluptatem impedit non ut aut."
},
"url": {
"en": "http://abshire.com/libero-voluptates-ipsum-illo-non"
}
}
},
{
"id": 12,
"name": "Lilly Konopelski",
"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": "Recusandae cum neque quo aut vero ut unde sint maxime et nam."
},
"description": {
"en": "Reiciendis ut porro eum sequi. Dicta voluptas maxime aspernatur. Quo et tempora quia omnis non et delectus et."
},
"url": {
"en": "http://www.vandervort.com/"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
11,
19,
18
]
},
{
"name": "...",
"category_ids": [
11,
19,
14
]
},
{
"name": "...",
"category_ids": [
13,
16,
14
]
}
]
}When returned in a response.
{
"id": 10,
"name": "Dr. Tyson Oberbrunner II",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"offers": [
{
"id": 19,
"name": "...",
"items": [
{
"type": "product",
"item_id": 12,
"percentage": 18,
"minimum": 12
},
{
"type": "product",
"item_id": 14,
"percentage": 10,
"minimum": 14
},
{
"type": "product",
"item_id": 18,
"percentage": 19,
"minimum": 18
}
]
},
{
"id": 11,
"name": "...",
"items": [
{
"type": "product",
"item_id": 18,
"percentage": 10,
"minimum": 12
},
{
"type": "product",
"item_id": 15,
"percentage": 19,
"minimum": 17
},
{
"type": "product",
"item_id": 14,
"percentage": 14,
"minimum": 14
}
]
},
{
"id": 15,
"name": "...",
"items": [
{
"type": "product",
"item_id": 10,
"percentage": 15,
"minimum": 11
},
{
"type": "product",
"item_id": 19,
"percentage": 10,
"minimum": 17
},
{
"type": "product",
"item_id": 16,
"percentage": 11,
"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": false
}
},
"allow_comments": true,
"allow_orders": true,
"delivery_use_intervals": false,
"categories": [
{
"id": 15,
"name": "Leonardo Roberts 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": "Quod quidem aut beatae eos fugit in numquam voluptates facilis."
},
"description": {
"en": "Sunt est debitis eveniet similique dolorum beatae iure. Nam aspernatur sit aut. Asperiores voluptas omnis impedit occaecati sed eum consequatur itaque."
},
"url": {
"en": "http://www.macejkovic.com/rerum-a-cupiditate-quod-facilis-provident-velit.html"
}
}
},
{
"id": 17,
"name": "Wilburn Batz",
"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": "Suscipit in veritatis numquam doloribus consequuntur nemo."
},
"description": {
"en": "Sint minima quis veniam alias cumque voluptatem maiores aut. Sit distinctio quos sit optio. Reprehenderit beatae nemo aliquid nam. Animi sit iste officia excepturi ullam in necessitatibus."
},
"url": {
"en": "https://www.king.com/quaerat-magnam-tempora-rem-quis-tenetur-consequatur"
}
}
},
{
"id": 13,
"name": "Hettie Heller 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": false
},
"seo": {
"title": {
"en": "Neque excepturi reiciendis necessitatibus qui."
},
"description": {
"en": "Ducimus dolore vero occaecati quo. Rem dignissimos libero neque esse enim illum culpa accusantium. Excepturi autem repellendus nihil veritatis."
},
"url": {
"en": "https://balistreri.com/ut-esse-et-ad-corrupti-et-dolor-veritatis-qui.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
12,
17,
12
]
},
{
"name": "...",
"category_ids": [
13,
19,
13
]
},
{
"name": "...",
"category_ids": [
14,
18,
16
]
}
]
}