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 |
| 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 |
| 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 |
| 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": 10,
"name": "Gerson Barton",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": true,
"url": "...",
"allow_order_comments": true,
"allow_product_comments": false,
"offers": [
{
"id": 15,
"name": "Black Friday"
},
{
"id": 15,
"name": "Black Friday"
},
{
"id": 18,
"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": false,
"delivery_use_intervals": false,
"categories": [
{
"id": 14,
"name": "Pascale Von",
"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": "A et dolorum quia voluptatum dolor accusamus sapiente ut ut."
},
"description": {
"en": "Quia voluptatem optio consequatur iure. Ratione neque voluptatem sint id quam non. Autem iste quibusdam maxime eum."
},
"url": {
"en": "http://www.jast.com/harum-cupiditate-dolores-sed-omnis-officiis-minus-illum"
}
}
},
{
"id": 12,
"name": "Dr. Antonio Lockman 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": true
},
"seo": {
"title": {
"en": "Minima temporibus enim accusantium rerum minima repellendus."
},
"description": {
"en": "Autem illum id beatae et non a impedit. Vero quia animi qui. Vel nulla occaecati error laborum ipsum quam repudiandae."
},
"url": {
"en": "http://orn.biz/hic-voluptas-natus-possimus-voluptatibus"
}
}
},
{
"id": 13,
"name": "Loraine Lindgren",
"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": "Voluptatem sed nemo consectetur rerum nobis natus odio tempore doloremque."
},
"description": {
"en": "Possimus culpa odit et mollitia esse quos quae. Animi iusto nihil pariatur minus. Tempora quo dicta exercitationem cum. Ipsum dignissimos provident inventore iusto."
},
"url": {
"en": "https://homenick.com/id-eos-ut-aut-eligendi.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
18,
13,
10
],
"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
}
},
{
"name": "...",
"category_ids": [
18,
12,
13
],
"id": 14,
"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,
14
],
"id": 14,
"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": false,
"joyn_enabled": false,
"hours": [
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"09:59 - 19:32",
"09:59 - 19:32",
"09:59 - 19:32"
]
},
{
"days": "5",
"times": [
"09:42 - 20:27",
"09:42 - 20:27",
"09:42 - 20:27"
]
},
{
"days": "5",
"times": [
"08:34 - 15:19",
"08:34 - 15:19",
"08:34 - 15:19"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"09:53 - 14:29",
"09:53 - 14:29",
"09:53 - 14:29"
]
},
{
"days": "5",
"times": [
"07:50 - 11:23",
"07:50 - 11:23",
"07:50 - 11:23"
]
},
{
"days": "5",
"times": [
"09:23 - 19:44",
"09:23 - 19:44",
"09:23 - 19:44"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"08:41 - 16:16",
"08:41 - 16:16",
"08:41 - 16:16"
]
},
{
"days": "5",
"times": [
"06:32 - 17:18",
"06:32 - 17:18",
"06:32 - 17:18"
]
},
{
"days": "5",
"times": [
"08:52 - 18:48",
"08:52 - 18:48",
"08:52 - 18:48"
]
}
]
}
],
"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": 10,
"name": "Bonita Cormier",
"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,
"offers": [
{
"id": 17,
"name": "Black Friday"
},
{
"id": 11,
"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": 11,
"name": "Simone Wintheiser",
"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": "Repellat iure velit maxime eligendi doloremque."
},
"description": {
"en": "Maiores sunt accusamus et quod. Ab et quia eum aut sapiente placeat quas. Dignissimos veniam dolores nemo asperiores."
},
"url": {
"en": "http://www.hilpert.com/sit-voluptates-repellat-nisi-ab-minima"
}
}
},
{
"id": 14,
"name": "Mia Rowe",
"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": "Officiis autem aut recusandae sed nam fugiat dolor architecto rem."
},
"description": {
"en": "Culpa autem autem voluptas necessitatibus sunt minus voluptas. Vero aperiam eum enim est. Sapiente veniam recusandae dolores veniam."
},
"url": {
"en": "http://casper.net/"
}
}
},
{
"id": 19,
"name": "Reina Maggio 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
}
],
"white_background": true
},
"seo": {
"title": {
"en": "Pariatur accusantium impedit provident facere et vel est et ab voluptatem."
},
"description": {
"en": "Sint aut aut vero enim suscipit exercitationem. Et possimus enim aperiam nesciunt. Consequuntur dolor dolore modi qui."
},
"url": {
"en": "http://bechtelar.com/"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
10,
10,
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": [
14,
17,
16
],
"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": [
13,
15,
15
],
"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": true,
"category_groups_overview": true,
"display_mode": "blocks",
"takeout_use_intervals": true,
"joyn_enabled": true,
"hours": [
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"09:30 - 17:56",
"09:30 - 17:56",
"09:30 - 17:56"
]
},
{
"days": "5",
"times": [
"06:26 - 16:33",
"06:26 - 16:33",
"06:26 - 16:33"
]
},
{
"days": "5",
"times": [
"07:36 - 13:41",
"07:36 - 13:41",
"07:36 - 13:41"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"09:36 - 11:15",
"09:36 - 11:15",
"09:36 - 11:15"
]
},
{
"days": "5",
"times": [
"09:31 - 13:58",
"09:31 - 13:58",
"09:31 - 13:58"
]
},
{
"days": "5",
"times": [
"09:46 - 19:35",
"09:46 - 19:35",
"09:46 - 19:35"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"06:16 - 10:44",
"06:16 - 10:44",
"06:16 - 10:44"
]
},
{
"days": "5",
"times": [
"07:20 - 11:58",
"07:20 - 11:58",
"07:20 - 11:58"
]
},
{
"days": "5",
"times": [
"06:28 - 13:30",
"06:28 - 13:30",
"06:28 - 13:30"
]
}
]
}
],
"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"
}