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 |
| 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 |
| 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 |
| 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 |
| 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": "Mrs. Celine Powlowski Jr.",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": false,
"url": "...",
"allow_order_comments": false,
"allow_product_comments": true,
"allow_order_messages": true,
"offers": [
{
"id": 19,
"name": "Black Friday"
},
{
"id": 19,
"name": "Black Friday"
},
{
"id": 14,
"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": true,
"categories": [
{
"id": 16,
"name": "Sage Haag",
"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": 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": "Odit tempora illo possimus aut voluptas voluptates ipsum architecto maiores."
},
"description": {
"en": "Facilis quisquam doloribus officia. Quidem enim aliquam aut consectetur cumque accusantium. Ut et eveniet ut est nihil molestiae."
},
"url": {
"en": "http://www.hoppe.biz/"
}
}
},
{
"id": 11,
"name": "Ricky Walsh",
"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": 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": "Eos corporis magnam minima consequatur suscipit omnis."
},
"description": {
"en": "Deleniti atque ad debitis corrupti harum vel. Voluptatibus suscipit in odit consequuntur. Voluptas cupiditate qui eum qui qui in et. Ut quidem enim aut aut."
},
"url": {
"en": "http://www.ward.com/eligendi-tenetur-animi-quo-facere-itaque"
}
}
},
{
"id": 17,
"name": "Cory Marks",
"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": "Molestias voluptas dolor pariatur non qui sit porro."
},
"description": {
"en": "Magnam sit dolorum facilis laborum est quae. Consequuntur sit corporis beatae illo. Excepturi distinctio a ducimus repellendus. In deserunt voluptas quos est aut."
},
"url": {
"en": "http://www.moore.biz/ut-nobis-aliquam-blanditiis-optio-at.html"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
10,
19,
15
],
"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": true
}
},
{
"name": "...",
"category_ids": [
19,
18,
16
],
"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": true
}
},
{
"name": "...",
"category_ids": [
10,
16,
15
],
"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": true,
"category_groups_overview": false,
"display_mode": "blocks",
"takeout_use_intervals": true,
"joyn_enabled": true,
"category_overview": false,
"fold_category_groups": false,
"hours": [
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"06:25 - 16:12",
"06:25 - 16:12",
"06:25 - 16:12"
]
},
{
"days": "5",
"times": [
"07:12 - 16:20",
"07:12 - 16:20",
"07:12 - 16:20"
]
},
{
"days": "5",
"times": [
"09:48 - 12:34",
"09:48 - 12:34",
"09:48 - 12:34"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"06:22 - 12:47",
"06:22 - 12:47",
"06:22 - 12:47"
]
},
{
"days": "5",
"times": [
"07:16 - 14:49",
"07:16 - 14:49",
"07:16 - 14:49"
]
},
{
"days": "5",
"times": [
"07:54 - 21:49",
"07:54 - 21:49",
"07:54 - 21:49"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"06:13 - 21:17",
"06:13 - 21:17",
"06:13 - 21:17"
]
},
{
"days": "5",
"times": [
"09:13 - 15:31",
"09:13 - 15:31",
"09:13 - 15:31"
]
},
{
"days": "5",
"times": [
"06:11 - 11:14",
"06:11 - 11:14",
"06:11 - 11:14"
]
}
]
}
],
"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"
}When returned in a response.
{
"id": 16,
"name": "Julianne Zulauf",
"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": true,
"allow_order_messages": true,
"offers": [
{
"id": 16,
"name": "Black Friday"
},
{
"id": 12,
"name": "Black Friday"
},
{
"id": 14,
"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": false,
"categories": [
{
"id": 10,
"name": "Allen 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
}
],
"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 amet accusantium autem aperiam reiciendis voluptatem accusamus animi."
},
"description": {
"en": "Maxime est culpa eveniet optio et magni non. Iste ad eos eveniet minima. Voluptatibus consequatur ut libero quia nihil porro aut sed."
},
"url": {
"en": "http://www.roob.com/et-soluta-velit-ea-libero-in-deleniti"
}
}
},
{
"id": 11,
"name": "Sadye Krajcik",
"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": 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": "Eius sit molestias laborum corporis dolorum tempore ratione."
},
"description": {
"en": "Praesentium deserunt magni et. Laborum neque sit eaque voluptatem hic. A aut facilis nesciunt velit et nulla qui. Ea error amet nostrum sequi."
},
"url": {
"en": "http://www.rosenbaum.com/et-porro-voluptate-cum-voluptas"
}
}
},
{
"id": 14,
"name": "Julie Rippin",
"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": "Voluptatem cupiditate nesciunt inventore itaque pariatur iusto ut inventore."
},
"description": {
"en": "Est dolores delectus iste voluptatibus sunt. Ut ea cum numquam. Nihil id iure nisi in similique architecto qui."
},
"url": {
"en": "http://www.turner.com/"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
19,
16,
11
],
"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": [
18,
14,
14
],
"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": [
12,
17,
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
}
}
],
"allow_invoices": true,
"category_groups_overview": true,
"display_mode": "blocks",
"takeout_use_intervals": true,
"joyn_enabled": false,
"category_overview": false,
"fold_category_groups": false,
"hours": [
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"06:34 - 11:42",
"06:34 - 11:42",
"06:34 - 11:42"
]
},
{
"days": "5",
"times": [
"09:34 - 18:13",
"09:34 - 18:13",
"09:34 - 18:13"
]
},
{
"days": "5",
"times": [
"06:15 - 15:54",
"06:15 - 15:54",
"06:15 - 15:54"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"09:59 - 21:31",
"09:59 - 21:31",
"09:59 - 21:31"
]
},
{
"days": "5",
"times": [
"07:29 - 16:42",
"07:29 - 16:42",
"07:29 - 16:42"
]
},
{
"days": "5",
"times": [
"08:26 - 12:40",
"08:26 - 12:40",
"08:26 - 12:40"
]
}
]
},
{
"name": "...",
"description": "...",
"type": "open",
"hours": [
{
"days": "5",
"times": [
"09:24 - 14:52",
"09:24 - 14:52",
"09:24 - 14:52"
]
},
{
"days": "5",
"times": [
"09:15 - 13:44",
"09:15 - 13:44",
"09:15 - 13:44"
]
},
{
"days": "5",
"times": [
"08:25 - 19:45",
"08:25 - 19:45",
"08:25 - 19:45"
]
}
]
}
],
"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"
}