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": 12,
"name": "Viviane Barrows II",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": true,
"url": "...",
"allow_order_comments": true,
"allow_product_comments": false,
"allow_order_messages": true,
"global_discount_percentage": 17,
"offers": [
{
"id": 18,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 19,
"recurring_on": {
"day_1": 17,
"day_2": 17,
"day_3": 18,
"day_4": 11,
"day_5": 15,
"day_6": 19,
"day_7": 15
},
"items": [
{
"type": "percentage",
"x": 10,
"y": 11,
"percentage": 12,
"minimum": 12,
"applies_to": "category",
"item_id": 11
},
{
"type": "percentage",
"x": 17,
"y": 16,
"percentage": 18,
"minimum": 17,
"applies_to": "category",
"item_id": 17
},
{
"type": "percentage",
"x": 19,
"y": 16,
"percentage": 15,
"minimum": 13,
"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": 15,
"recurring_on": {
"day_1": 16,
"day_2": 15,
"day_3": 15,
"day_4": 14,
"day_5": 16,
"day_6": 17,
"day_7": 14
},
"items": [
{
"type": "percentage",
"x": 12,
"y": 16,
"percentage": 12,
"minimum": 19,
"applies_to": "category",
"item_id": 18
},
{
"type": "percentage",
"x": 17,
"y": 19,
"percentage": 16,
"minimum": 16,
"applies_to": "category",
"item_id": 14
},
{
"type": "percentage",
"x": 14,
"y": 12,
"percentage": 17,
"minimum": 16,
"applies_to": "category",
"item_id": 17
}
]
},
{
"id": 13,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 19,
"recurring_on": {
"day_1": 17,
"day_2": 15,
"day_3": 17,
"day_4": 14,
"day_5": 10,
"day_6": 19,
"day_7": 18
},
"items": [
{
"type": "percentage",
"x": 19,
"y": 16,
"percentage": 12,
"minimum": 19,
"applies_to": "category",
"item_id": 14
},
{
"type": "percentage",
"x": 14,
"y": 17,
"percentage": 12,
"minimum": 11,
"applies_to": "category",
"item_id": 13
},
{
"type": "percentage",
"x": 11,
"y": 15,
"percentage": 17,
"minimum": 10,
"applies_to": "category",
"item_id": 14
}
]
}
],
"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": false,
"categories": [
{
"id": 11,
"name": "Dr. Geo Keeling II",
"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": true
},
"seo": {
"title": {
"en": "Aut assumenda ipsum autem ea temporibus ut vel dicta doloribus quo."
},
"description": {
"en": "Suscipit minus consectetur corrupti numquam quo. Sunt quas placeat eum et molestiae est velit. Non autem qui dolor."
},
"url": {
"en": "http://www.roberts.com/et-nemo-cupiditate-aliquam"
}
}
},
{
"id": 16,
"name": "Keegan Dickinson 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
},
"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": "Ut ut eius reprehenderit sit illum."
},
"description": {
"en": "Autem iusto aliquam quisquam sequi quidem et voluptas nam. Reprehenderit consectetur culpa illum quis perspiciatis voluptates enim. Odit ad atque quasi nihil officiis at."
},
"url": {
"en": "https://www.dare.com/eveniet-veritatis-quo-velit-sed-mollitia-voluptas-voluptatem"
}
}
},
{
"id": 11,
"name": "Dr. Issac Gusikowski 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
},
"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": "Aut dolorum sed maiores eos neque et suscipit et inventore ipsa."
},
"description": {
"en": "Et voluptatem similique et reiciendis vitae. Quos et fuga est. Ratione maxime autem eos."
},
"url": {
"en": "http://www.jacobs.net/et-nobis-quibusdam-debitis-adipisci-quia-distinctio"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
10,
16,
17
],
"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": false
}
},
{
"name": "...",
"category_ids": [
13,
10,
14
],
"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,
11,
17
],
"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": false
}
}
],
"allow_invoices": true,
"category_groups_overview": false,
"display_mode": "blocks",
"takeout_use_intervals": true,
"joyn_enabled": false,
"category_overview": false,
"fold_category_groups": false,
"currency": "EUR"
}When returned in a response.
{
"id": 10,
"name": "Jayce Hane",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": true,
"url": "...",
"allow_order_comments": false,
"allow_product_comments": true,
"allow_order_messages": true,
"global_discount_percentage": 11,
"offers": [
{
"id": 15,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 19,
"recurring_on": {
"day_1": 11,
"day_2": 18,
"day_3": 16,
"day_4": 13,
"day_5": 18,
"day_6": 12,
"day_7": 18
},
"items": [
{
"type": "percentage",
"x": 16,
"y": 18,
"percentage": 18,
"minimum": 16,
"applies_to": "category",
"item_id": 10
},
{
"type": "percentage",
"x": 11,
"y": 12,
"percentage": 14,
"minimum": 11,
"applies_to": "category",
"item_id": 14
},
{
"type": "percentage",
"x": 15,
"y": 18,
"percentage": 19,
"minimum": 14,
"applies_to": "category",
"item_id": 17
}
]
},
{
"id": 10,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 19,
"recurring_on": {
"day_1": 15,
"day_2": 12,
"day_3": 14,
"day_4": 14,
"day_5": 18,
"day_6": 18,
"day_7": 11
},
"items": [
{
"type": "percentage",
"x": 14,
"y": 18,
"percentage": 12,
"minimum": 11,
"applies_to": "category",
"item_id": 17
},
{
"type": "percentage",
"x": 12,
"y": 17,
"percentage": 10,
"minimum": 12,
"applies_to": "category",
"item_id": 17
},
{
"type": "percentage",
"x": 13,
"y": 17,
"percentage": 18,
"minimum": 14,
"applies_to": "category",
"item_id": 12
}
]
},
{
"id": 16,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 10,
"recurring_on": {
"day_1": 13,
"day_2": 14,
"day_3": 12,
"day_4": 15,
"day_5": 11,
"day_6": 16,
"day_7": 10
},
"items": [
{
"type": "percentage",
"x": 15,
"y": 19,
"percentage": 10,
"minimum": 18,
"applies_to": "category",
"item_id": 18
},
{
"type": "percentage",
"x": 10,
"y": 16,
"percentage": 12,
"minimum": 10,
"applies_to": "category",
"item_id": 18
},
{
"type": "percentage",
"x": 17,
"y": 17,
"percentage": 11,
"minimum": 11,
"applies_to": "category",
"item_id": 10
}
]
}
],
"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": 18,
"white_background": false
}
},
"allow_orders": false,
"delivery_use_intervals": true,
"categories": [
{
"id": 16,
"name": "Prof. Andres Ritchie MD",
"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": false
},
"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": "Minima qui voluptatibus voluptatibus qui qui error."
},
"description": {
"en": "Odit qui distinctio omnis. Ad eius possimus aut ad ut neque. Dolorem mollitia reiciendis hic consequuntur ad."
},
"url": {
"en": "http://www.mayer.com/illo-alias-nihil-id-voluptatibus-repudiandae-perferendis.html"
}
}
},
{
"id": 13,
"name": "Mac Runte",
"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": 14,
"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": 12,
"white_background": false
},
"seo": {
"title": {
"en": "Quos fugiat aut ea consequatur expedita praesentium."
},
"description": {
"en": "Ut fugit et ex voluptatem. Deserunt nihil et odit deleniti eligendi. Maxime error sapiente et in ut voluptatem. Temporibus libero ex deserunt fugiat non earum rem."
},
"url": {
"en": "https://lubowitz.com/consectetur-dolorem-pariatur-est-beatae-soluta.html"
}
}
},
{
"id": 16,
"name": "Ressie Farrell",
"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": 10,
"white_background": false
},
"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": 11,
"white_background": true
},
"seo": {
"title": {
"en": "Omnis officia fugit maiores aut rem et placeat recusandae."
},
"description": {
"en": "Molestiae neque voluptas voluptatem distinctio et quia ipsam. Officiis aut quas a iste fuga. Non est magni quis debitis omnis."
},
"url": {
"en": "http://lind.org/iste-maxime-maiores-facere-accusantium.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
12,
18,
11
],
"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
}
],
"file_id": 19,
"white_background": true
}
},
{
"name": "...",
"category_ids": [
13,
10,
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
}
],
"file_id": 15,
"white_background": false
}
},
{
"name": "...",
"category_ids": [
15,
17,
18
],
"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": 13,
"white_background": true
}
}
],
"allow_invoices": true,
"category_groups_overview": false,
"display_mode": "blocks",
"takeout_use_intervals": true,
"joyn_enabled": false,
"category_overview": false,
"fold_category_groups": false,
"currency": "EUR"
}