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": "Joanne Stoltenberg",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"offers": [
{
"id": 13,
"name": "...",
"items": [
{
"type": "product",
"item_id": 10,
"percentage": 14,
"minimum": 13
},
{
"type": "product",
"item_id": 12,
"percentage": 17,
"minimum": 17
},
{
"type": "product",
"item_id": 12,
"percentage": 19,
"minimum": 19
}
]
},
{
"id": 12,
"name": "...",
"items": [
{
"type": "product",
"item_id": 13,
"percentage": 18,
"minimum": 18
},
{
"type": "product",
"item_id": 10,
"percentage": 15,
"minimum": 13
},
{
"type": "product",
"item_id": 10,
"percentage": 17,
"minimum": 13
}
]
},
{
"id": 10,
"name": "...",
"items": [
{
"type": "product",
"item_id": 12,
"percentage": 14,
"minimum": 18
},
{
"type": "product",
"item_id": 10,
"percentage": 12,
"minimum": 17
},
{
"type": "product",
"item_id": 13,
"percentage": 13,
"minimum": 18
}
]
}
],
"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": 17,
"name": "Alexane Ryan",
"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": "Sed assumenda dolor et eum velit exercitationem perspiciatis ad cum."
},
"description": {
"en": "Eveniet sint et est non voluptatem et. Sed in ex in modi."
},
"url": {
"en": "http://okuneva.biz/necessitatibus-amet-aut-eius-debitis-unde-deserunt"
}
}
},
{
"id": 17,
"name": "Kade Franecki",
"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": "Voluptatem aspernatur qui rem ut consequatur consequatur quia rerum."
},
"description": {
"en": "Soluta quaerat qui fugit. Voluptatem similique nisi earum optio odio est."
},
"url": {
"en": "http://herman.com/porro-dicta-omnis-natus-aspernatur-illo-velit"
}
}
},
{
"id": 10,
"name": "Prof. Myron Schmidt",
"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": "Asperiores fugiat architecto suscipit ut repellendus blanditiis magni."
},
"description": {
"en": "Est omnis nostrum recusandae rem nesciunt sunt. Error pariatur consequatur placeat unde voluptas praesentium. Exercitationem et quidem et nobis neque nostrum quisquam. Sapiente rerum nostrum rerum."
},
"url": {
"en": "http://www.bergstrom.com/"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
17,
10,
13
]
},
{
"name": "...",
"category_ids": [
12,
17,
19
]
},
{
"name": "...",
"category_ids": [
16,
11,
13
]
}
],
"currency": "EUR"
}When returned in a response.
{
"id": 10,
"name": "Hailee Ullrich",
"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": 16,
"minimum": 17
},
{
"type": "product",
"item_id": 17,
"percentage": 18,
"minimum": 18
},
{
"type": "product",
"item_id": 18,
"percentage": 16,
"minimum": 11
}
]
},
{
"id": 14,
"name": "...",
"items": [
{
"type": "product",
"item_id": 18,
"percentage": 17,
"minimum": 10
},
{
"type": "product",
"item_id": 18,
"percentage": 17,
"minimum": 12
},
{
"type": "product",
"item_id": 13,
"percentage": 12,
"minimum": 19
}
]
},
{
"id": 18,
"name": "...",
"items": [
{
"type": "product",
"item_id": 18,
"percentage": 16,
"minimum": 15
},
{
"type": "product",
"item_id": 10,
"percentage": 14,
"minimum": 17
},
{
"type": "product",
"item_id": 10,
"percentage": 12,
"minimum": 11
}
]
}
],
"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": "Clementine Gutmann",
"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": "Nemo sint animi dolores a culpa praesentium."
},
"description": {
"en": "Blanditiis deserunt quae expedita in ut. Sed quaerat voluptatem voluptate officiis dolores. Dolores exercitationem exercitationem est reprehenderit quis molestiae fugiat."
},
"url": {
"en": "http://www.hane.com/debitis-neque-ut-et-dolor-temporibus-ullam"
}
}
},
{
"id": 11,
"name": "Lorena Mayer",
"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": "Itaque ullam ut et et architecto id dolorem itaque eaque delectus."
},
"description": {
"en": "Non reiciendis dolor dolorem corporis rem quia. Modi quia doloremque sit laborum. Molestiae debitis ut sed voluptas. Quo aperiam et provident quibusdam sint."
},
"url": {
"en": "http://www.mueller.com/impedit-itaque-numquam-dolorem-et.html"
}
}
},
{
"id": 13,
"name": "Felton Swift",
"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": "Aut necessitatibus ratione nostrum voluptate et."
},
"description": {
"en": "Enim vel voluptatem maiores voluptas commodi sit. Et qui dolorum beatae magni voluptatem expedita quasi. Vel molestiae doloremque esse sint animi doloremque."
},
"url": {
"en": "http://green.biz/autem-sed-quaerat-neque-repudiandae-tenetur.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
16,
18,
14
]
},
{
"name": "...",
"category_ids": [
13,
18,
11
]
},
{
"name": "...",
"category_ids": [
17,
12,
16
]
}
],
"currency": "EUR"
}