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": "Kailee Nicolas",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"offers": [
{
"id": 12,
"name": "Black Friday"
},
{
"id": 10,
"name": "Black Friday"
},
{
"id": 12,
"name": "Black Friday"
}
],
"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": true,
"categories": [
{
"id": 13,
"name": "Prof. Reta Thiel",
"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": "Deleniti saepe soluta quod odio quia in itaque vitae nulla quis."
},
"description": {
"en": "Est est voluptates in neque modi repudiandae hic. Vel corrupti maiores magnam quia voluptatum. Commodi debitis accusantium tempore similique omnis et."
},
"url": {
"en": "http://kreiger.org/sint-rerum-est-ut-sed-itaque"
}
}
},
{
"id": 10,
"name": "Ms. Magnolia Anderson 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": true
},
"seo": {
"title": {
"en": "Assumenda velit aut deleniti aut et aliquam omnis."
},
"description": {
"en": "Illo sequi enim sunt molestiae aspernatur. Dolor aperiam quo ut itaque eius. Debitis ea nam et sapiente dicta."
},
"url": {
"en": "http://boyer.biz/omnis-ullam-deserunt-alias-explicabo-et-quam"
}
}
},
{
"id": 10,
"name": "Teresa McDermott",
"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": "Iure eos quia sint quia quos dolores praesentium in natus ut."
},
"description": {
"en": "Quod odio sed consequuntur vel. Possimus aspernatur veritatis sunt ab. Dolor sint id voluptatibus et labore."
},
"url": {
"en": "https://www.boyer.org/possimus-impedit-eum-quo-aut-aut-perspiciatis"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
13,
18,
18
]
},
{
"name": "...",
"category_ids": [
15,
13,
17
]
},
{
"name": "...",
"category_ids": [
19,
10,
11
]
}
],
"currency": "EUR"
}When returned in a response.
{
"id": 10,
"name": "Mr. Lucious Konopelski MD",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"offers": [
{
"id": 14,
"name": "Black Friday"
},
{
"id": 13,
"name": "Black Friday"
},
{
"id": 16,
"name": "Black Friday"
}
],
"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": false,
"allow_orders": false,
"delivery_use_intervals": true,
"categories": [
{
"id": 13,
"name": "Kareem Monahan",
"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": "Aut impedit earum eum maiores ex aut."
},
"description": {
"en": "Ipsum laborum nemo iusto fugit dicta eligendi voluptas. Quae sapiente unde et et ex. Quo eos eaque alias magni qui eum eum."
},
"url": {
"en": "http://www.leuschke.com/consequuntur-rem-repellendus-unde-ab"
}
}
},
{
"id": 18,
"name": "Mrs. Destiney Senger",
"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": "Iure perspiciatis et consequatur molestiae corrupti beatae deserunt commodi esse voluptatum."
},
"description": {
"en": "Hic velit atque unde est non similique. Aut asperiores quam accusantium qui adipisci consequuntur. Consequatur est accusantium quos quasi sunt sed."
},
"url": {
"en": "https://boyle.org/qui-temporibus-vero-deserunt-quam-quas-non-dolorum.html"
}
}
},
{
"id": 15,
"name": "Hyman Mayert 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": false
},
"seo": {
"title": {
"en": "Magnam est ut praesentium minima natus tempora sint aut accusamus beatae."
},
"description": {
"en": "Consequatur dolorum beatae dolorum a quia. Laboriosam laborum sit corporis cum temporibus minima. Tempore laboriosam enim atque rerum earum. Natus aliquam in quis."
},
"url": {
"en": "http://moore.com/quia-natus-pariatur-ut-dignissimos-sequi-omnis"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
19,
18,
10
]
},
{
"name": "...",
"category_ids": [
12,
14,
12
]
},
{
"name": "...",
"category_ids": [
16,
14,
16
]
}
],
"currency": "EUR"
}