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 |
| allow_order_messages | Bool | A boolean value |
| global_discount_percentage | Int | Discount percentage for all products |
| offers | [Offer.detailed] | Array of Offer.detailed |
| 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 |
| category_overview | Bool | Show an overview of all the categories on the webshop homepage |
| fold_category_groups | Bool | Whether the shop prefers to hide all the categories for all category groups by default |
| 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 |
| allow_order_messages | Bool | A boolean value |
| global_discount_percentage | Int | Discount percentage for all products |
| offers | [Offer.detailed] | Array of Offer.detailed |
| 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 |
| category_overview | Bool | Show an overview of all the categories on the webshop homepage |
| fold_category_groups | Bool | Whether the shop prefers to hide all the categories for all category groups by default |
| currency | Currency | 3 letter ISO 4217 currency name (string) |
When used inside a request.
{
"id": 17,
"name": "Prof. Moshe Bergnaum DDS",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": true,
"url": "...",
"allow_order_comments": false,
"allow_product_comments": true,
"allow_order_messages": false,
"global_discount_percentage": 16,
"offers": [
{
"id": 17,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 15,
"recurring_on": {
"day_1": 15,
"day_2": 15,
"day_3": 14,
"day_4": 17,
"day_5": 10,
"day_6": 19,
"day_7": 10
},
"items": [
{
"type": "percentage",
"x": 13,
"y": 13,
"percentage": 15,
"minimum": 17,
"applies_to": "category",
"item_id": 17
},
{
"type": "percentage",
"x": 13,
"y": 15,
"percentage": 19,
"minimum": 19,
"applies_to": "category",
"item_id": 17
},
{
"type": "percentage",
"x": 19,
"y": 17,
"percentage": 10,
"minimum": 12,
"applies_to": "category",
"item_id": 14
}
]
},
{
"id": 16,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 16,
"recurring_on": {
"day_1": 14,
"day_2": 19,
"day_3": 14,
"day_4": 15,
"day_5": 10,
"day_6": 10,
"day_7": 16
},
"items": [
{
"type": "percentage",
"x": 13,
"y": 11,
"percentage": 12,
"minimum": 12,
"applies_to": "category",
"item_id": 16
},
{
"type": "percentage",
"x": 13,
"y": 16,
"percentage": 13,
"minimum": 17,
"applies_to": "category",
"item_id": 11
},
{
"type": "percentage",
"x": 10,
"y": 14,
"percentage": 17,
"minimum": 11,
"applies_to": "category",
"item_id": 19
}
]
},
{
"id": 15,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 12,
"recurring_on": {
"day_1": 12,
"day_2": 12,
"day_3": 17,
"day_4": 16,
"day_5": 10,
"day_6": 14,
"day_7": 11
},
"items": [
{
"type": "percentage",
"x": 17,
"y": 12,
"percentage": 18,
"minimum": 11,
"applies_to": "category",
"item_id": 11
},
{
"type": "percentage",
"x": 15,
"y": 10,
"percentage": 16,
"minimum": 13,
"applies_to": "category",
"item_id": 15
},
{
"type": "percentage",
"x": 14,
"y": 17,
"percentage": 12,
"minimum": 17,
"applies_to": "category",
"item_id": 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_orders": false,
"delivery_use_intervals": false,
"categories": [
{
"id": 16,
"name": "Prof. Alicia Schaefer",
"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
},
"only_order_in_store": false,
"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
},
"seo": {
"title": {
"en": "Sit qui similique dolorem quia deserunt et tenetur officiis cum aut."
},
"description": {
"en": "Enim atque dolore quis sint fugit. Est quasi dolores ut et. Et vitae molestiae et id commodi dolor. Eius laborum quidem maiores dolores."
},
"url": {
"en": "http://davis.com/molestiae-nesciunt-itaque-officiis-delectus"
}
}
},
{
"id": 12,
"name": "Dr. Tod Hoppe",
"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
},
"only_order_in_store": false,
"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
},
"seo": {
"title": {
"en": "Error non laboriosam blanditiis nihil illo unde in."
},
"description": {
"en": "Facilis est omnis ullam eligendi. Illum et quasi quam aut. Ut qui quia ipsam et nemo rerum rem. Aliquam error eveniet et molestiae corporis eligendi fugiat."
},
"url": {
"en": "https://www.brown.com/magni-minus-sunt-nobis"
}
}
},
{
"id": 19,
"name": "Dr. Jayne Leffler",
"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
},
"only_order_in_store": true,
"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
},
"seo": {
"title": {
"en": "Doloremque ullam perspiciatis et ut consequuntur assumenda porro facilis et."
},
"description": {
"en": "Assumenda consequatur quisquam expedita. Aspernatur qui hic voluptatem iure consequatur voluptates quaerat. Eaque velit vitae accusamus mollitia enim sed numquam quo."
},
"url": {
"en": "http://gerlach.org/est-expedita-tempore-aspernatur-quia-reprehenderit-exercitationem-et"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
13,
19,
11
],
"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": false
}
},
{
"name": "...",
"category_ids": [
14,
16,
18
],
"id": 13,
"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": [
18,
14,
10
],
"id": 18,
"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": false,
"display_mode": "blocks",
"takeout_use_intervals": true,
"joyn_enabled": true,
"category_overview": true,
"fold_category_groups": true,
"currency": "EUR"
}When returned in a response.
{
"id": 19,
"name": "Cale Ondricka Sr.",
"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": true,
"allow_order_messages": true,
"global_discount_percentage": 18,
"offers": [
{
"id": 18,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 12,
"recurring_on": {
"day_1": 17,
"day_2": 19,
"day_3": 16,
"day_4": 17,
"day_5": 17,
"day_6": 18,
"day_7": 10
},
"items": [
{
"type": "percentage",
"x": 13,
"y": 12,
"percentage": 13,
"minimum": 10,
"applies_to": "category",
"item_id": 13
},
{
"type": "percentage",
"x": 17,
"y": 17,
"percentage": 14,
"minimum": 19,
"applies_to": "category",
"item_id": 17
},
{
"type": "percentage",
"x": 18,
"y": 14,
"percentage": 11,
"minimum": 14,
"applies_to": "category",
"item_id": 12
}
]
},
{
"id": 11,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 18,
"recurring_on": {
"day_1": 16,
"day_2": 18,
"day_3": 19,
"day_4": 15,
"day_5": 16,
"day_6": 19,
"day_7": 18
},
"items": [
{
"type": "percentage",
"x": 18,
"y": 12,
"percentage": 19,
"minimum": 13,
"applies_to": "category",
"item_id": 16
},
{
"type": "percentage",
"x": 11,
"y": 17,
"percentage": 12,
"minimum": 11,
"applies_to": "category",
"item_id": 16
},
{
"type": "percentage",
"x": 13,
"y": 11,
"percentage": 19,
"minimum": 10,
"applies_to": "category",
"item_id": 17
}
]
},
{
"id": 18,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 12,
"recurring_on": {
"day_1": 19,
"day_2": 19,
"day_3": 18,
"day_4": 13,
"day_5": 11,
"day_6": 19,
"day_7": 12
},
"items": [
{
"type": "percentage",
"x": 14,
"y": 14,
"percentage": 18,
"minimum": 19,
"applies_to": "category",
"item_id": 19
},
{
"type": "percentage",
"x": 15,
"y": 15,
"percentage": 14,
"minimum": 12,
"applies_to": "category",
"item_id": 19
},
{
"type": "percentage",
"x": 13,
"y": 16,
"percentage": 12,
"minimum": 16,
"applies_to": "category",
"item_id": 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
}
],
"file_id": 10,
"white_background": false
}
},
"allow_orders": true,
"delivery_use_intervals": true,
"categories": [
{
"id": 12,
"name": "Alisa Hilpert",
"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
}
],
"file_id": 16,
"white_background": true
},
"only_order_in_store": true,
"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
}
],
"file_id": 13,
"white_background": false
},
"seo": {
"title": {
"en": "Ab impedit nulla excepturi facere quia eius voluptatum hic saepe."
},
"description": {
"en": "Facere repellat illum est dicta voluptas in. Dolor qui consectetur rerum beatae. Quasi repellendus voluptatum alias at omnis praesentium ut. Labore quia itaque odit quo."
},
"url": {
"en": "http://lemke.com/debitis-dolorem-et-ad-sequi-numquam-et-dolorem.html"
}
}
},
{
"id": 16,
"name": "Lia Mueller 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
}
],
"file_id": 12,
"white_background": true
},
"only_order_in_store": false,
"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
}
],
"file_id": 12,
"white_background": true
},
"seo": {
"title": {
"en": "Veritatis iure nostrum totam nesciunt ullam repudiandae dolorem nihil."
},
"description": {
"en": "Veritatis nostrum quia perspiciatis odio non dolorem distinctio. Aut voluptatem sed maiores suscipit est ducimus fuga. Error accusamus nulla impedit distinctio a iure."
},
"url": {
"en": "http://www.greenfelder.info/repellendus-corrupti-quis-dignissimos.html"
}
}
},
{
"id": 17,
"name": "Greta Bernhard",
"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
}
],
"file_id": 11,
"white_background": true
},
"only_order_in_store": true,
"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
}
],
"file_id": 18,
"white_background": false
},
"seo": {
"title": {
"en": "Officiis nisi beatae dignissimos velit sint illo qui deserunt."
},
"description": {
"en": "Ut quo et vero eos id nobis hic adipisci. Rerum est velit delectus qui maiores voluptatibus voluptatibus. Aliquam illum fuga quisquam quo quia in."
},
"url": {
"en": "http://www.paucek.org/"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
16,
13,
15
],
"id": 18,
"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
}
],
"file_id": 10,
"white_background": false
}
},
{
"name": "...",
"category_ids": [
14,
18,
13
],
"id": 19,
"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
}
],
"file_id": 16,
"white_background": true
}
},
{
"name": "...",
"category_ids": [
11,
18,
17
],
"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
}
],
"file_id": 15,
"white_background": true
}
}
],
"allow_invoices": false,
"category_groups_overview": true,
"display_mode": "blocks",
"takeout_use_intervals": false,
"joyn_enabled": true,
"category_overview": false,
"fold_category_groups": false,
"currency": "EUR"
}