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 |
| allow_comments | Bool | A boolean value |
| offers | [Offer.simple] | Array of Offer.simple |
| images | [String: Image] | Dictionary of Image with keys of type String |
| 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. |
| allow_invoices | Bool | A boolean value |
| 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 |
| allow_comments | Bool | A boolean value |
| offers | [Offer.simple] | Array of Offer.simple |
| images | [String: Image] | Dictionary of Image with keys of type String |
| 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. |
| allow_invoices | Bool | A boolean value |
| currency | Currency | 3 letter ISO 4217 currency name (string) |
When used inside a request.
{
"id": 19,
"name": "Prof. Evelyn Smitham",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": false,
"offers": [
{
"id": 15,
"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_orders": true,
"delivery_use_intervals": true,
"categories": [
{
"id": 11,
"name": "Prof. Braulio Nienow",
"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": "Dignissimos rerum distinctio voluptate eos officia."
},
"description": {
"en": "Blanditiis eius facere voluptas quod exercitationem vel et tempore. Et ut ut totam non cum qui aut. Culpa eos in ab quis tempora rem. Iusto sed quia sunt ut."
},
"url": {
"en": "http://www.fay.com/molestiae-odit-dolorum-repudiandae-magni-ut-alias.html"
}
}
},
{
"id": 11,
"name": "Glenna Morar",
"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": "Consequuntur a quisquam aliquam blanditiis aut."
},
"description": {
"en": "Velit molestiae consectetur iusto maxime voluptates. Sequi et possimus voluptatem facere ipsam quasi. Ipsam soluta eveniet et voluptates harum fugiat. Cum corrupti ipsum ut laudantium consequatur."
},
"url": {
"en": "http://mcdermott.biz/"
}
}
},
{
"id": 16,
"name": "Izabella Beier",
"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": "Vitae quam qui occaecati voluptatem est."
},
"description": {
"en": "Sunt totam sunt accusamus quia consequatur quia. Sed est repellat quaerat repellendus suscipit aspernatur. Doloremque similique qui laborum officia voluptatibus dolore."
},
"url": {
"en": "http://www.muller.org/vitae-voluptates-minima-nobis-neque-quam"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
11,
14,
10
]
},
{
"name": "...",
"category_ids": [
14,
16,
11
]
},
{
"name": "...",
"category_ids": [
19,
10,
15
]
}
],
"allow_invoices": true,
"currency": "EUR"
}When returned in a response.
{
"id": 18,
"name": "Dr. Lawson Mitchell III",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": false,
"offers": [
{
"id": 13,
"name": "Black Friday"
},
{
"id": 14,
"name": "Black Friday"
},
{
"id": 10,
"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_orders": true,
"delivery_use_intervals": true,
"categories": [
{
"id": 18,
"name": "Demond Moore",
"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": "Ab provident corporis maxime omnis."
},
"description": {
"en": "Necessitatibus quia error sit et. Cupiditate sunt atque est alias impedit in possimus. Ut voluptas eveniet similique sed."
},
"url": {
"en": "https://www.tromp.org/voluptatum-dolorem-nisi-cupiditate-ducimus-dolor-facilis"
}
}
},
{
"id": 16,
"name": "Holly Koelpin",
"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": "Nobis ipsam et quia saepe amet saepe recusandae repudiandae magni pariatur ullam."
},
"description": {
"en": "Amet adipisci nihil cumque et distinctio. Aut qui unde omnis sequi. Adipisci placeat aperiam dolorem consequuntur tenetur dolorem."
},
"url": {
"en": "http://www.berge.com/quaerat-id-omnis-nostrum-consectetur-ab-sunt-earum.html"
}
}
},
{
"id": 17,
"name": "Mrs. Lucinda Hane",
"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": "Iste illo et occaecati autem iure tenetur quaerat vero."
},
"description": {
"en": "Tempore voluptas quibusdam in sed inventore sunt. Libero sit illum modi omnis delectus molestias necessitatibus. Corporis quod aliquam quam et ipsa iste. Dolore nesciunt fugit autem."
},
"url": {
"en": "http://www.hansen.com/"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
10,
17,
13
]
},
{
"name": "...",
"category_ids": [
11,
17,
11
]
},
{
"name": "...",
"category_ids": [
16,
14,
19
]
}
],
"allow_invoices": false,
"currency": "EUR"
}