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": 14,
"name": "Alexis Feeney",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"offers": [
{
"id": 12,
"name": "...",
"items": [
{
"type": "product",
"item_id": 13,
"percentage": 10,
"minimum": 13
},
{
"type": "product",
"item_id": 13,
"percentage": 13,
"minimum": 19
},
{
"type": "product",
"item_id": 16,
"percentage": 19,
"minimum": 12
}
]
},
{
"id": 13,
"name": "...",
"items": [
{
"type": "product",
"item_id": 10,
"percentage": 17,
"minimum": 14
},
{
"type": "product",
"item_id": 18,
"percentage": 15,
"minimum": 19
},
{
"type": "product",
"item_id": 14,
"percentage": 12,
"minimum": 18
}
]
},
{
"id": 15,
"name": "...",
"items": [
{
"type": "product",
"item_id": 11,
"percentage": 17,
"minimum": 19
},
{
"type": "product",
"item_id": 15,
"percentage": 17,
"minimum": 17
},
{
"type": "product",
"item_id": 10,
"percentage": 11,
"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": true
}
},
"allow_comments": false,
"allow_orders": true,
"delivery_use_intervals": false,
"categories": [
{
"id": 10,
"name": "Guy Yost",
"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": "Magnam praesentium sint repellendus eum a sint saepe."
},
"description": {
"en": "Sequi velit qui aliquam nobis porro. Tenetur et et consequatur excepturi non et. Ut qui qui qui voluptatum."
},
"url": {
"en": "http://ferry.com/iure-at-excepturi-ut-blanditiis-nisi-fuga-sunt-quis.html"
}
}
},
{
"id": 15,
"name": "Darrick Boyer",
"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 vel explicabo sunt veritatis ratione sed commodi aspernatur sit voluptatem veniam."
},
"description": {
"en": "A nostrum dolores rerum quia deleniti. Et expedita inventore corrupti dolor maiores. Et necessitatibus sint enim ipsa odio et sit."
},
"url": {
"en": "http://www.bahringer.info/"
}
}
},
{
"id": 15,
"name": "Kaylin Reichert",
"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": "Labore vitae et earum quisquam quis tempora quos."
},
"description": {
"en": "Et illum illo molestias ea reiciendis ut voluptate aliquam. Natus sunt laudantium sed. Dolorem harum ratione odio."
},
"url": {
"en": "https://schneider.org/vel-autem-est-quasi-porro-earum-qui.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
19,
10,
11
]
},
{
"name": "...",
"category_ids": [
11,
18,
12
]
},
{
"name": "...",
"category_ids": [
12,
16,
16
]
}
],
"currency": "EUR"
}When returned in a response.
{
"id": 10,
"name": "Miss Vada Schamberger MD",
"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": 15,
"percentage": 12,
"minimum": 19
},
{
"type": "product",
"item_id": 16,
"percentage": 10,
"minimum": 13
},
{
"type": "product",
"item_id": 14,
"percentage": 18,
"minimum": 10
}
]
},
{
"id": 10,
"name": "...",
"items": [
{
"type": "product",
"item_id": 19,
"percentage": 15,
"minimum": 15
},
{
"type": "product",
"item_id": 14,
"percentage": 14,
"minimum": 10
},
{
"type": "product",
"item_id": 12,
"percentage": 17,
"minimum": 17
}
]
},
{
"id": 15,
"name": "...",
"items": [
{
"type": "product",
"item_id": 14,
"percentage": 13,
"minimum": 17
},
{
"type": "product",
"item_id": 15,
"percentage": 11,
"minimum": 12
},
{
"type": "product",
"item_id": 10,
"percentage": 13,
"minimum": 16
}
]
}
],
"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": false,
"categories": [
{
"id": 12,
"name": "Perry Murphy 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": "Nulla necessitatibus qui nihil odit ut voluptas nobis aspernatur voluptatum."
},
"description": {
"en": "Animi molestias tempore natus et earum. Quam ab aliquid quia enim nostrum. Est tempore id est molestiae sit."
},
"url": {
"en": "http://kulas.com/"
}
}
},
{
"id": 11,
"name": "Dr. Wilson Dickens 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": "Molestiae provident itaque maiores facilis nisi voluptas deleniti."
},
"description": {
"en": "Sunt molestiae temporibus dicta possimus consectetur unde minima. Nulla et voluptatibus porro sed ullam."
},
"url": {
"en": "http://www.breitenberg.com/officiis-qui-veniam-at-labore.html"
}
}
},
{
"id": 11,
"name": "Taryn Lind",
"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": "Saepe perferendis repudiandae ratione dolorem quia praesentium doloribus tenetur nesciunt totam."
},
"description": {
"en": "Ut repudiandae odit voluptatum eos. Iusto velit voluptates ad in vel delectus consequatur voluptatem. Ut illo hic sit nulla sed dolores quia."
},
"url": {
"en": "https://hane.com/rerum-velit-quaerat-distinctio-ipsam-corporis.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
13,
12,
12
]
},
{
"name": "...",
"category_ids": [
11,
19,
11
]
},
{
"name": "...",
"category_ids": [
14,
16,
19
]
}
],
"currency": "EUR"
}