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": 19,
"name": "Buster Cormier",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"offers": [
{
"id": 15,
"name": "...",
"items": [
{
"type": "product",
"item_id": 14,
"percentage": 11,
"minimum": 15
},
{
"type": "product",
"item_id": 12,
"percentage": 17,
"minimum": 17
},
{
"type": "product",
"item_id": 12,
"percentage": 11,
"minimum": 18
}
]
},
{
"id": 12,
"name": "...",
"items": [
{
"type": "product",
"item_id": 12,
"percentage": 12,
"minimum": 17
},
{
"type": "product",
"item_id": 10,
"percentage": 10,
"minimum": 10
},
{
"type": "product",
"item_id": 16,
"percentage": 12,
"minimum": 11
}
]
},
{
"id": 18,
"name": "...",
"items": [
{
"type": "product",
"item_id": 10,
"percentage": 12,
"minimum": 16
},
{
"type": "product",
"item_id": 14,
"percentage": 19,
"minimum": 10
},
{
"type": "product",
"item_id": 11,
"percentage": 11,
"minimum": 19
}
]
}
],
"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": 12,
"name": "Ms. Mabelle Bashirian IV",
"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": "Et aut et et autem consectetur eligendi cumque rerum ducimus error."
},
"description": {
"en": "Cum sunt consequatur provident veniam quia. Libero est neque est officiis. Itaque suscipit iure tempora natus. Fugit porro ut odio dolorem ex doloremque voluptatem."
},
"url": {
"en": "http://kautzer.biz/eum-eos-in-assumenda-consectetur-quam"
}
}
},
{
"id": 11,
"name": "Thaddeus King",
"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": "Aperiam recusandae esse quis doloremque et commodi repudiandae sit odio eos."
},
"description": {
"en": "Ipsa et aspernatur autem necessitatibus quia quia sequi. Sunt quia tempora perspiciatis. Aut eum nam repudiandae tempora."
},
"url": {
"en": "http://morissette.com/"
}
}
},
{
"id": 10,
"name": "Miss Callie Glover",
"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 iste voluptatibus amet aut neque corporis ea aliquid est."
},
"description": {
"en": "Odit officia quis perspiciatis vel. Labore laboriosam consequatur cupiditate placeat cumque dolore voluptas. Molestiae officia qui assumenda placeat."
},
"url": {
"en": "http://roberts.com/placeat-dolorum-sit-est-voluptatem.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
15,
16,
19
]
},
{
"name": "...",
"category_ids": [
18,
11,
15
]
},
{
"name": "...",
"category_ids": [
10,
13,
19
]
}
],
"currency": "EUR"
}When returned in a response.
{
"id": 11,
"name": "Mr. Saige Monahan III",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"offers": [
{
"id": 13,
"name": "...",
"items": [
{
"type": "product",
"item_id": 18,
"percentage": 13,
"minimum": 18
},
{
"type": "product",
"item_id": 10,
"percentage": 18,
"minimum": 11
},
{
"type": "product",
"item_id": 12,
"percentage": 12,
"minimum": 18
}
]
},
{
"id": 17,
"name": "...",
"items": [
{
"type": "product",
"item_id": 18,
"percentage": 13,
"minimum": 15
},
{
"type": "product",
"item_id": 11,
"percentage": 11,
"minimum": 16
},
{
"type": "product",
"item_id": 14,
"percentage": 17,
"minimum": 17
}
]
},
{
"id": 12,
"name": "...",
"items": [
{
"type": "product",
"item_id": 14,
"percentage": 14,
"minimum": 18
},
{
"type": "product",
"item_id": 15,
"percentage": 18,
"minimum": 16
},
{
"type": "product",
"item_id": 10,
"percentage": 15,
"minimum": 13
}
]
}
],
"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": 11,
"name": "Mustafa Gleason",
"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": "Ut vitae odio excepturi magni magnam est dolore eum."
},
"description": {
"en": "Ullam et culpa veritatis et. Ea voluptate vero et veniam. Consectetur ullam voluptas ut maxime nihil id."
},
"url": {
"en": "http://fritsch.com/"
}
}
},
{
"id": 15,
"name": "Earnestine Hagenes",
"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": "Quaerat itaque dignissimos quam est et itaque sunt a accusamus."
},
"description": {
"en": "Nostrum nemo aut est voluptas autem vitae. Enim voluptatum cupiditate debitis et quia voluptate corrupti. Officia error facilis ullam."
},
"url": {
"en": "http://www.sipes.info/eos-voluptas-vitae-nihil-est.html"
}
}
},
{
"id": 11,
"name": "Sylvan Barton",
"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": "In quo rem sed molestiae molestiae ullam saepe iure nisi magnam dolorem."
},
"description": {
"en": "Fugiat natus eligendi est dolore. Facilis autem aut sit vel deleniti dolores. Non eius magni dicta nulla."
},
"url": {
"en": "http://monahan.com/hic-maiores-nisi-consequuntur-nulla.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
15,
14,
13
]
},
{
"name": "...",
"category_ids": [
10,
17,
16
]
},
{
"name": "...",
"category_ids": [
10,
14,
16
]
}
],
"currency": "EUR"
}