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": 18,
"name": "Rylan Vandervort",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"offers": [
{
"id": 16,
"name": "...",
"items": [
{
"type": "product",
"item_id": 14,
"percentage": 13,
"minimum": 15
},
{
"type": "product",
"item_id": 13,
"percentage": 13,
"minimum": 10
},
{
"type": "product",
"item_id": 11,
"percentage": 11,
"minimum": 18
}
]
},
{
"id": 18,
"name": "...",
"items": [
{
"type": "product",
"item_id": 11,
"percentage": 18,
"minimum": 14
},
{
"type": "product",
"item_id": 15,
"percentage": 18,
"minimum": 17
},
{
"type": "product",
"item_id": 10,
"percentage": 16,
"minimum": 17
}
]
},
{
"id": 11,
"name": "...",
"items": [
{
"type": "product",
"item_id": 16,
"percentage": 12,
"minimum": 12
},
{
"type": "product",
"item_id": 17,
"percentage": 15,
"minimum": 15
},
{
"type": "product",
"item_id": 10,
"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": false,
"allow_orders": true,
"delivery_use_intervals": true,
"categories": [
{
"id": 19,
"name": "Clemens Witting",
"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": "Cumque non natus sint enim porro."
},
"description": {
"en": "Molestiae libero explicabo eius aut perferendis ab nulla. Neque tempora aut rerum cum explicabo distinctio. Voluptatum pariatur est sit quia et fuga maxime."
},
"url": {
"en": "https://herzog.com/facere-eum-omnis-eligendi-quibusdam-quisquam-illo-ipsum-quia.html"
}
}
},
{
"id": 12,
"name": "Tyson Haag",
"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": "Quod id culpa rerum minima vel amet ipsa sit est velit."
},
"description": {
"en": "Voluptas voluptatem consequatur ullam veritatis. Qui minima suscipit nulla facilis porro. Atque sed at neque quis quia quos. Soluta expedita similique velit maxime recusandae."
},
"url": {
"en": "https://www.quitzon.com/velit-omnis-voluptas-delectus-est"
}
}
},
{
"id": 12,
"name": "Ms. Caterina Wuckert DDS",
"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": "Voluptatem dolor qui illo qui vel expedita."
},
"description": {
"en": "Architecto explicabo necessitatibus deleniti ut. Voluptates nemo officiis et soluta ad quod excepturi. Necessitatibus fugiat vel maiores est. Voluptatem illo laborum repellat porro provident."
},
"url": {
"en": "http://www.parker.com/labore-nisi-quas-in-cum-qui-beatae"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
12,
17,
12
]
},
{
"name": "...",
"category_ids": [
10,
19,
18
]
},
{
"name": "...",
"category_ids": [
19,
15,
17
]
}
],
"currency": "EUR"
}When returned in a response.
{
"id": 15,
"name": "Patrick Jenkins",
"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": 14,
"percentage": 10,
"minimum": 15
},
{
"type": "product",
"item_id": 11,
"percentage": 11,
"minimum": 18
},
{
"type": "product",
"item_id": 11,
"percentage": 16,
"minimum": 17
}
]
},
{
"id": 10,
"name": "...",
"items": [
{
"type": "product",
"item_id": 17,
"percentage": 19,
"minimum": 18
},
{
"type": "product",
"item_id": 13,
"percentage": 10,
"minimum": 12
},
{
"type": "product",
"item_id": 12,
"percentage": 15,
"minimum": 11
}
]
},
{
"id": 14,
"name": "...",
"items": [
{
"type": "product",
"item_id": 11,
"percentage": 18,
"minimum": 17
},
{
"type": "product",
"item_id": 11,
"percentage": 17,
"minimum": 18
},
{
"type": "product",
"item_id": 10,
"percentage": 16,
"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": false,
"allow_orders": true,
"delivery_use_intervals": true,
"categories": [
{
"id": 10,
"name": "Evalyn Bashirian",
"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": "Dolorum autem tenetur et voluptatem suscipit rerum esse et omnis voluptas."
},
"description": {
"en": "Omnis voluptatem omnis nihil laudantium voluptatem exercitationem cum. Nesciunt delectus cumque magnam necessitatibus dignissimos. Quia fuga eligendi at sit."
},
"url": {
"en": "http://dietrich.com/dicta-unde-incidunt-maxime-iure-quas-fugit-omnis"
}
}
},
{
"id": 10,
"name": "Cristian Ziemann",
"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": "Corrupti non a sunt sed architecto."
},
"description": {
"en": "Vel nihil quaerat deleniti id aut. Doloremque quia quo iure."
},
"url": {
"en": "http://www.sauer.net/"
}
}
},
{
"id": 16,
"name": "Dr. Kameron Kris",
"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": "Repellendus consequatur quo tenetur soluta perspiciatis vel qui consequatur fugit."
},
"description": {
"en": "Culpa qui dolor sed beatae incidunt ipsam dolorem. Perspiciatis dolorem hic illo rem ea ipsa."
},
"url": {
"en": "http://www.mills.com/ut-ut-ex-odio-fuga-nihil.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
10,
14,
11
]
},
{
"name": "...",
"category_ids": [
16,
19,
11
]
},
{
"name": "...",
"category_ids": [
12,
11,
12
]
}
],
"currency": "EUR"
}