Shop.extended

Request

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
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.
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
currency Currency 3 letter ISO 4217 currency name (string)

Response

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
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.
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
currency Currency 3 letter ISO 4217 currency name (string)

Examples

Request

When used inside a request.

Example 1

{
    "id": 15,
    "name": "Mozell Weber V",
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE"
    },
    "allow_comments": false,
    "offers": [
        {
            "id": 18,
            "name": "Black Friday"
        },
        {
            "id": 14,
            "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": 18,
            "name": "Freda Jacobs",
            "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": "Nihil quod distinctio eligendi rerum sint occaecati vel."
                },
                "description": {
                    "en": "Laudantium nam quo placeat et neque quia. Aliquid ex ut qui in nobis blanditiis dignissimos. Et omnis natus reprehenderit ipsam occaecati. Cumque quod accusantium nisi."
                },
                "url": {
                    "en": "http://nader.com/"
                }
            }
        },
        {
            "id": 16,
            "name": "Sim Durgan",
            "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": "Exercitationem necessitatibus qui occaecati numquam vitae tenetur alias quae natus magni ut."
                },
                "description": {
                    "en": "Minus praesentium et omnis ut quae. In et molestias animi officia qui. Distinctio ipsa magnam error quasi. Aut voluptates dolores incidunt est quia."
                },
                "url": {
                    "en": "https://www.batz.com/quaerat-sed-blanditiis-nemo-et-perferendis-mollitia-nesciunt"
                }
            }
        },
        {
            "id": 16,
            "name": "Mrs. Blanche Crona",
            "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": "Minima iusto hic reiciendis est alias dicta maiores."
                },
                "description": {
                    "en": "Consequatur sunt ea ut voluptas. Impedit quia et eligendi quis nam fuga maiores fuga. Sint incidunt quo eveniet amet numquam. Labore sit animi omnis sapiente dolorem vero et."
                },
                "url": {
                    "en": "http://www.schimmel.com/facere-eum-nesciunt-voluptatem-ea"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": "...",
            "category_ids": [
                12,
                19,
                15
            ]
        },
        {
            "name": "...",
            "category_ids": [
                14,
                11,
                17
            ]
        },
        {
            "name": "...",
            "category_ids": [
                14,
                17,
                16
            ]
        }
    ],
    "hours": [
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "09:43 - 18:17",
                        "09:43 - 18:17",
                        "09:43 - 18:17"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:59 - 20:23",
                        "09:59 - 20:23",
                        "09:59 - 20:23"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "08:11 - 21:26",
                        "08:11 - 21:26",
                        "08:11 - 21:26"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "07:19 - 10:56",
                        "07:19 - 10:56",
                        "07:19 - 10:56"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "08:11 - 17:53",
                        "08:11 - 17:53",
                        "08:11 - 17:53"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "06:51 - 14:41",
                        "06:51 - 14:41",
                        "06:51 - 14:41"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "06:25 - 20:43",
                        "06:25 - 20:43",
                        "06:25 - 20:43"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "08:46 - 15:24",
                        "08:46 - 15:24",
                        "08:46 - 15:24"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:24 - 20:22",
                        "09:24 - 20:22",
                        "09:24 - 20:22"
                    ]
                }
            ]
        }
    ],
    "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"
        }
    ],
    "currency": "EUR"
}

Response

When returned in a response.

Example 1

{
    "id": 15,
    "name": "Carlo Koss PhD",
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE",
        "position": {
            "latitude": 1.54361,
            "longitude": 0.45645
        }
    },
    "allow_comments": false,
    "offers": [
        {
            "id": 13,
            "name": "Black Friday"
        },
        {
            "id": 16,
            "name": "Black Friday"
        },
        {
            "id": 15,
            "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": 10,
            "name": "Talia Lubowitz",
            "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": "Doloribus nesciunt vel deserunt rem aspernatur laboriosam."
                },
                "description": {
                    "en": "Saepe et sequi necessitatibus aliquam. Explicabo quaerat hic neque ut doloribus iste. Soluta dolore quisquam autem aspernatur ut. Velit sunt culpa illum incidunt et amet voluptatem ratione."
                },
                "url": {
                    "en": "http://dach.com/accusantium-esse-molestias-natus-sit-natus-similique-magni"
                }
            }
        },
        {
            "id": 18,
            "name": "Prof. Alan Carroll",
            "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": "Non est molestiae minima ut pariatur."
                },
                "description": {
                    "en": "Aspernatur totam at eaque in. Corrupti minima incidunt mollitia officia ut quaerat."
                },
                "url": {
                    "en": "http://wintheiser.com/aut-mollitia-tempore-non-eveniet-accusantium-occaecati-suscipit"
                }
            }
        },
        {
            "id": 18,
            "name": "Anabel Renner",
            "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": "Odio architecto non voluptatibus sunt ipsam maiores est qui eius."
                },
                "description": {
                    "en": "Tenetur ut sit voluptatem error doloribus rerum suscipit. Dolor in non enim impedit repellendus. Autem voluptatem cum qui qui."
                },
                "url": {
                    "en": "http://sanford.biz/"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": "...",
            "category_ids": [
                17,
                19,
                12
            ]
        },
        {
            "name": "...",
            "category_ids": [
                12,
                16,
                17
            ]
        },
        {
            "name": "...",
            "category_ids": [
                12,
                18,
                12
            ]
        }
    ],
    "hours": [
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "08:17 - 19:39",
                        "08:17 - 19:39",
                        "08:17 - 19:39"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "06:51 - 12:13",
                        "06:51 - 12:13",
                        "06:51 - 12:13"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:45 - 10:32",
                        "07:45 - 10:32",
                        "07:45 - 10:32"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "09:42 - 20:52",
                        "09:42 - 20:52",
                        "09:42 - 20:52"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:41 - 15:59",
                        "09:41 - 15:59",
                        "09:41 - 15:59"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:14 - 13:37",
                        "09:14 - 13:37",
                        "09:14 - 13:37"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "06:35 - 20:10",
                        "06:35 - 20:10",
                        "06:35 - 20:10"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:13 - 17:31",
                        "09:13 - 17:31",
                        "09:13 - 17:31"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:22 - 16:44",
                        "07:22 - 16:44",
                        "07:22 - 16:44"
                    ]
                }
            ]
        }
    ],
    "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"
        }
    ],
    "currency": "EUR"
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.5.0 stable