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 |
| url | String | A String value |
| allow_order_comments | Bool | A boolean value |
| allow_product_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 |
| category_groups_overview | Bool | Show an overview of all the category groups on the webshop homepage |
| display_mode | String | String enumarion of 'blocks', 'list' |
| takeout_use_intervals | Bool | A boolean value |
| joyn_enabled | 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 |
| url | String | A String value |
| allow_order_comments | Bool | A boolean value |
| allow_product_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 |
| category_groups_overview | Bool | Show an overview of all the category groups on the webshop homepage |
| display_mode | String | String enumarion of 'blocks', 'list' |
| takeout_use_intervals | Bool | A boolean value |
| joyn_enabled | Bool | A boolean value |
| currency | Currency | 3 letter ISO 4217 currency name (string) |
When used inside a request.
{
"id": 18,
"name": "Mr. Keyon Predovic",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": false,
"url": "...",
"allow_order_comments": true,
"allow_product_comments": false,
"offers": [
{
"id": 16,
"name": "Black Friday"
},
{
"id": 19,
"name": "Black Friday"
},
{
"id": 13,
"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": true
}
},
"allow_orders": true,
"delivery_use_intervals": true,
"categories": [
{
"id": 16,
"name": "Muriel Schiller",
"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": "Voluptas sit aut vitae sapiente nobis ea veritatis esse provident molestias."
},
"description": {
"en": "Fuga rerum sapiente libero voluptatibus sunt earum ipsum. Mollitia debitis dolor reprehenderit dolores. Nobis sapiente autem reiciendis beatae voluptatem."
},
"url": {
"en": "http://skiles.com/"
}
}
},
{
"id": 18,
"name": "Daren Turner",
"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": "Quod fuga molestiae recusandae perspiciatis reprehenderit qui omnis enim nisi corrupti ut."
},
"description": {
"en": "Excepturi soluta ut id odit quis et inventore. Nobis praesentium et a labore. Ducimus sed soluta omnis qui."
},
"url": {
"en": "http://www.bailey.org/maiores-similique-et-voluptate-nulla.html"
}
}
},
{
"id": 15,
"name": "Thea Ryan I",
"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": "Aperiam aut totam aut doloribus modi ut ut."
},
"description": {
"en": "Aut porro est est et doloremque. Velit nihil sapiente dolores quis inventore tenetur voluptatem. Velit non ducimus pariatur temporibus facere tempora et. Et ad veritatis quasi vitae repudiandae."
},
"url": {
"en": "https://www.sporer.com/asperiores-ut-voluptas-porro-est"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
14,
17,
18
],
"id": 11,
"image": {
"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
}
},
{
"name": "...",
"category_ids": [
15,
10,
18
],
"id": 10,
"image": {
"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
}
},
{
"name": "...",
"category_ids": [
17,
19,
19
],
"id": 10,
"image": {
"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_invoices": false,
"category_groups_overview": true,
"display_mode": "blocks",
"takeout_use_intervals": false,
"joyn_enabled": true,
"currency": "EUR"
}When returned in a response.
{
"id": 10,
"name": "Ahmed Gutkowski",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": false,
"url": "...",
"allow_order_comments": false,
"allow_product_comments": false,
"offers": [
{
"id": 16,
"name": "Black Friday"
},
{
"id": 12,
"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": false,
"delivery_use_intervals": false,
"categories": [
{
"id": 17,
"name": "Maurine Sanford",
"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": "Praesentium accusantium fugit veniam qui et ea."
},
"description": {
"en": "Sequi velit ut dolorem ea consequatur laborum repellendus. Alias molestias aliquam debitis sed rem eligendi commodi. Placeat saepe et labore temporibus. Aliquam dolorem adipisci veritatis omnis."
},
"url": {
"en": "http://www.bruen.biz/alias-occaecati-ipsum-reprehenderit-perferendis-velit-eos"
}
}
},
{
"id": 16,
"name": "Alexandrea Sauer V",
"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": "Molestiae voluptatem reprehenderit fugiat nihil quae consequatur fuga et ut omnis totam."
},
"description": {
"en": "Velit libero aut aut alias blanditiis eum. Aut id deserunt cupiditate. Modi recusandae dolores similique nisi quia suscipit ex. Aut unde voluptatum dolor officia deleniti vel animi itaque."
},
"url": {
"en": "http://luettgen.com/impedit-maiores-magnam-nostrum-dolores-ipsam"
}
}
},
{
"id": 13,
"name": "Isabelle Gerhold",
"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": "Voluptatibus beatae nihil et temporibus."
},
"description": {
"en": "Expedita enim doloribus unde veritatis. Consectetur mollitia architecto sed sapiente. Porro suscipit quo odit asperiores ipsa sunt. Omnis libero tenetur in quod facilis magnam."
},
"url": {
"en": "http://skiles.com/aut-omnis-tempore-eum-veniam-quos-nostrum.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
10,
11,
15
],
"id": 12,
"image": {
"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
}
},
{
"name": "...",
"category_ids": [
15,
18,
11
],
"id": 10,
"image": {
"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
}
},
{
"name": "...",
"category_ids": [
17,
10,
15
],
"id": 17,
"image": {
"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_invoices": true,
"category_groups_overview": true,
"display_mode": "blocks",
"takeout_use_intervals": true,
"joyn_enabled": false,
"currency": "EUR"
}