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 |
| hours | [MethodHours] | Information about the opening hours, delivery hours... for all available methods and machines |
| contact | Contact | Contact details of a shop |
| messages | [Message] | You are required to keep track of the messages the user saw. When you receive new messages, you should indicate this in the app with a bubble icon (e.g. red circle with number of new messages) |
| info | [Message] | Same as messages, but you shouldn't notify the user when this changes or is received for the first time |
| status | ShopStatus | |
| has_specialties | 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 |
| 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 |
| hours | [MethodHours] | Information about the opening hours, delivery hours... for all available methods and machines |
| contact | Contact | Contact details of a shop |
| messages | [Message] | You are required to keep track of the messages the user saw. When you receive new messages, you should indicate this in the app with a bubble icon (e.g. red circle with number of new messages) |
| info | [Message] | Same as messages, but you shouldn't notify the user when this changes or is received for the first time |
| status | ShopStatus | |
| has_specialties | Bool | A boolean value |
| currency | Currency | 3 letter ISO 4217 currency name (string) |
When used inside a request.
{
"id": 15,
"name": "Gracie Hickle",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": true,
"url": "...",
"allow_order_comments": false,
"allow_product_comments": false,
"allow_order_messages": true,
"global_discount_percentage": 17,
"offers": [
{
"id": 12,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 12,
"recurring_on": {
"day_1": 10,
"day_2": 17,
"day_3": 11,
"day_4": 18,
"day_5": 10,
"day_6": 14,
"day_7": 12
},
"items": [
{
"type": "percentage",
"x": 15,
"y": 10,
"percentage": 17,
"minimum": 11,
"applies_to": "category",
"item_id": 15
},
{
"type": "percentage",
"x": 13,
"y": 18,
"percentage": 17,
"minimum": 12,
"applies_to": "category",
"item_id": 10
},
{
"type": "percentage",
"x": 11,
"y": 14,
"percentage": 11,
"minimum": 11,
"applies_to": "category",
"item_id": 12
}
]
},
{
"id": 18,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 17,
"recurring_on": {
"day_1": 17,
"day_2": 16,
"day_3": 15,
"day_4": 19,
"day_5": 17,
"day_6": 15,
"day_7": 13
},
"items": [
{
"type": "percentage",
"x": 15,
"y": 11,
"percentage": 11,
"minimum": 19,
"applies_to": "category",
"item_id": 10
},
{
"type": "percentage",
"x": 15,
"y": 11,
"percentage": 12,
"minimum": 13,
"applies_to": "category",
"item_id": 10
},
{
"type": "percentage",
"x": 10,
"y": 13,
"percentage": 17,
"minimum": 17,
"applies_to": "category",
"item_id": 15
}
]
},
{
"id": 16,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 13,
"recurring_on": {
"day_1": 11,
"day_2": 10,
"day_3": 13,
"day_4": 17,
"day_5": 12,
"day_6": 19,
"day_7": 17
},
"items": [
{
"type": "percentage",
"x": 14,
"y": 11,
"percentage": 10,
"minimum": 15,
"applies_to": "category",
"item_id": 12
},
{
"type": "percentage",
"x": 18,
"y": 10,
"percentage": 14,
"minimum": 18,
"applies_to": "category",
"item_id": 18
},
{
"type": "percentage",
"x": 15,
"y": 14,
"percentage": 14,
"minimum": 11,
"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
}
],
"white_background": false
}
},
"allow_orders": true,
"delivery_use_intervals": true,
"categories": [
{
"id": 11,
"name": "Morgan Kuhn",
"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": "Porro eos temporibus excepturi sit aliquid omnis nesciunt a laborum non."
},
"description": {
"en": "Accusamus amet ab sit nam. Repudiandae facilis est ut. Esse accusantium eos nulla repellendus."
},
"url": {
"en": "http://www.wolff.com/et-qui-porro-sed-dolore"
}
}
},
{
"id": 17,
"name": "Magdalena Nitzsche",
"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": true
},
"seo": {
"title": {
"en": "Sit nam sed voluptates beatae id saepe omnis eum."
},
"description": {
"en": "Aut cum ut aut consectetur odit consequatur et molestias. Dicta voluptatibus accusantium quod libero reiciendis consequatur. Vitae laborum temporibus necessitatibus alias."
},
"url": {
"en": "https://www.braun.biz/id-id-quia-enim-officiis-sit-sed-ratione-debitis"
}
}
},
{
"id": 12,
"name": "Ms. Trudie Sipes 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": 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": "Doloribus natus molestias cum possimus repellat optio harum et."
},
"description": {
"en": "Commodi praesentium quae debitis dolorem error quam et. Nemo id maiores aliquid ut. Cumque esse suscipit eos. Doloribus nam et id autem."
},
"url": {
"en": "http://www.botsford.com/illum-porro-odio-voluptas-quis-et-eos-impedit.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
12,
19,
13
],
"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
}
},
{
"name": "...",
"category_ids": [
12,
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
}
},
{
"name": "...",
"category_ids": [
13,
16,
12
],
"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
}
}
],
"allow_invoices": false,
"category_groups_overview": false,
"display_mode": "blocks",
"takeout_use_intervals": true,
"joyn_enabled": false,
"category_overview": true,
"fold_category_groups": false,
"hours": [
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"09:35 - 14:28",
"09:35 - 14:28",
"09:35 - 14:28"
]
},
{
"days": "5",
"times": [
"07:46 - 16:39",
"07:46 - 16:39",
"07:46 - 16:39"
]
},
{
"days": "5",
"times": [
"08:14 - 20:26",
"08:14 - 20:26",
"08:14 - 20:26"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"08:49 - 13:50",
"08:49 - 13:50",
"08:49 - 13:50"
]
},
{
"days": "5",
"times": [
"09:44 - 15:55",
"09:44 - 15:55",
"09:44 - 15:55"
]
},
{
"days": "5",
"times": [
"08:22 - 18:11",
"08:22 - 18:11",
"08:22 - 18:11"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"08:27 - 20:28",
"08:27 - 20:28",
"08:27 - 20:28"
]
},
{
"days": "5",
"times": [
"08:39 - 13:10",
"08:39 - 13:10",
"08:39 - 13:10"
]
},
{
"days": "5",
"times": [
"08:40 - 14:43",
"08:40 - 14:43",
"08:40 - 14:43"
]
}
]
}
],
"contact": {
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"telephone": "+32 475 00 00 00",
"vat": "BE0123.456.789",
"social": {
"facebook": "https://example.com",
"twitter": "https://example.com",
"snapchat": "https://example.com",
"instagram": "https://example.com",
"pinterest": "https://example.com",
"youtube": "https://example.com"
},
"website": "https://example.com",
"email": "example@domain.com"
},
"messages": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
],
"info": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
],
"status": {
"open": {
"status": "closes-soon",
"text": "..."
},
"takeout": "...",
"delivery": "...",
"latch": "..."
},
"has_specialties": true,
"currency": "EUR"
}When returned in a response.
{
"id": 12,
"name": "Ms. Alicia Moen III",
"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": true,
"allow_product_comments": false,
"allow_order_messages": false,
"global_discount_percentage": 13,
"offers": [
{
"id": 16,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 19,
"recurring_on": {
"day_1": 16,
"day_2": 10,
"day_3": 13,
"day_4": 13,
"day_5": 17,
"day_6": 10,
"day_7": 17
},
"items": [
{
"type": "percentage",
"x": 11,
"y": 14,
"percentage": 14,
"minimum": 15,
"applies_to": "category",
"item_id": 13
},
{
"type": "percentage",
"x": 13,
"y": 14,
"percentage": 15,
"minimum": 14,
"applies_to": "category",
"item_id": 19
},
{
"type": "percentage",
"x": 15,
"y": 19,
"percentage": 17,
"minimum": 16,
"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": 13,
"recurring_on": {
"day_1": 12,
"day_2": 18,
"day_3": 12,
"day_4": 10,
"day_5": 17,
"day_6": 15,
"day_7": 16
},
"items": [
{
"type": "percentage",
"x": 17,
"y": 12,
"percentage": 18,
"minimum": 15,
"applies_to": "category",
"item_id": 16
},
{
"type": "percentage",
"x": 10,
"y": 14,
"percentage": 19,
"minimum": 16,
"applies_to": "category",
"item_id": 16
},
{
"type": "percentage",
"x": 12,
"y": 14,
"percentage": 15,
"minimum": 18,
"applies_to": "category",
"item_id": 15
}
]
},
{
"id": 14,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 18,
"recurring_on": {
"day_1": 10,
"day_2": 18,
"day_3": 10,
"day_4": 10,
"day_5": 14,
"day_6": 14,
"day_7": 11
},
"items": [
{
"type": "percentage",
"x": 15,
"y": 15,
"percentage": 13,
"minimum": 18,
"applies_to": "category",
"item_id": 10
},
{
"type": "percentage",
"x": 17,
"y": 15,
"percentage": 14,
"minimum": 15,
"applies_to": "category",
"item_id": 18
},
{
"type": "percentage",
"x": 15,
"y": 17,
"percentage": 10,
"minimum": 11,
"applies_to": "category",
"item_id": 15
}
]
}
],
"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": false,
"categories": [
{
"id": 19,
"name": "Camille Larkin III",
"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": 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": true
},
"seo": {
"title": {
"en": "Est dolorum dolor non excepturi."
},
"description": {
"en": "Dolores voluptatum aut quos. Dolores iste veniam in non rerum totam. Velit voluptates excepturi dignissimos qui id nostrum."
},
"url": {
"en": "http://pagac.net/natus-vel-et-necessitatibus-aut-et-aut-inventore"
}
}
},
{
"id": 16,
"name": "Antonette Blick",
"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": "Qui dicta voluptatum esse quas laboriosam repellendus magni."
},
"description": {
"en": "Aliquam minima at quaerat est ipsa nemo. Voluptatem laudantium dolores nemo accusantium enim minima temporibus. Nihil quod corporis dicta voluptatem sunt. Nemo optio similique ut autem."
},
"url": {
"en": "http://schaefer.com/dolor-aliquid-hic-modi-occaecati-delectus-qui-voluptatem.html"
}
}
},
{
"id": 11,
"name": "Dr. Randy Balistreri",
"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": "Facilis sunt dicta nemo et qui quibusdam fugiat omnis ipsum."
},
"description": {
"en": "Est eveniet iusto non tempore. Ad sed et nesciunt reiciendis libero itaque. Iusto autem inventore illo commodi perferendis ipsam in."
},
"url": {
"en": "http://okon.info/"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
16,
15,
14
],
"id": 16,
"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": [
15,
18,
10
],
"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
}
],
"white_background": true
}
},
{
"name": "...",
"category_ids": [
18,
18,
12
],
"id": 15,
"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": true,
"display_mode": "blocks",
"takeout_use_intervals": true,
"joyn_enabled": true,
"category_overview": false,
"fold_category_groups": true,
"hours": [
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"08:59 - 14:14",
"08:59 - 14:14",
"08:59 - 14:14"
]
},
{
"days": "5",
"times": [
"07:43 - 21:12",
"07:43 - 21:12",
"07:43 - 21:12"
]
},
{
"days": "5",
"times": [
"08:14 - 16:56",
"08:14 - 16:56",
"08:14 - 16:56"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"09:58 - 21:18",
"09:58 - 21:18",
"09:58 - 21:18"
]
},
{
"days": "5",
"times": [
"09:16 - 19:23",
"09:16 - 19:23",
"09:16 - 19:23"
]
},
{
"days": "5",
"times": [
"09:33 - 20:15",
"09:33 - 20:15",
"09:33 - 20:15"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"07:16 - 12:15",
"07:16 - 12:15",
"07:16 - 12:15"
]
},
{
"days": "5",
"times": [
"09:12 - 21:21",
"09:12 - 21:21",
"09:12 - 21:21"
]
},
{
"days": "5",
"times": [
"06:40 - 12:43",
"06:40 - 12:43",
"06:40 - 12:43"
]
}
]
}
],
"contact": {
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"telephone": "+32 475 00 00 00",
"vat": "BE0123.456.789",
"social": {
"facebook": "https://example.com",
"twitter": "https://example.com",
"snapchat": "https://example.com",
"instagram": "https://example.com",
"pinterest": "https://example.com",
"youtube": "https://example.com"
},
"website": "https://example.com",
"email": "example@domain.com"
},
"messages": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
],
"info": [
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
},
{
"name": "...",
"title": "...",
"text": "...",
"type": "HTML"
}
],
"status": {
"open": {
"status": "closes-soon",
"text": "..."
},
"takeout": "...",
"delivery": "...",
"latch": "..."
},
"has_specialties": false,
"currency": "EUR"
}