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": 18,
    "name": "Camron Champlin",
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE"
    },
    "allow_comments": true,
    "offers": [
        {
            "id": 11,
            "name": "Black Friday"
        },
        {
            "id": 11,
            "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": true,
    "categories": [
        {
            "id": 19,
            "name": "Madilyn Considine",
            "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": "Earum voluptas quam necessitatibus mollitia accusantium nulla."
                },
                "description": {
                    "en": "Et culpa sed in harum et quis exercitationem. Recusandae odio dolores repellendus tempora ab et dolor."
                },
                "url": {
                    "en": "http://www.reichel.com/"
                }
            }
        },
        {
            "id": 12,
            "name": "Chesley Hansen",
            "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": "Facilis perferendis quis deserunt tempora saepe totam."
                },
                "description": {
                    "en": "Quis fugiat rem repellat sint ratione id. Illum totam nostrum minus et iusto voluptas debitis. Qui quaerat magni distinctio explicabo perferendis. Et aut minima magnam."
                },
                "url": {
                    "en": "http://www.weimann.com/est-tempore-fuga-aliquam-ad-reprehenderit-odio-atque.html"
                }
            }
        },
        {
            "id": 14,
            "name": "Clair Schmeler",
            "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": "Laudantium voluptate asperiores sit non dolores vitae molestiae a sed repellendus quod."
                },
                "description": {
                    "en": "Maxime qui beatae similique culpa. Aut maiores ea aliquam possimus qui omnis. Accusamus necessitatibus deleniti laboriosam ea."
                },
                "url": {
                    "en": "http://www.collier.com/incidunt-ut-eos-maxime-modi-necessitatibus-illo-sunt"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": "...",
            "category_ids": [
                18,
                18,
                11
            ]
        },
        {
            "name": "...",
            "category_ids": [
                10,
                16,
                10
            ]
        },
        {
            "name": "...",
            "category_ids": [
                17,
                17,
                12
            ]
        }
    ],
    "hours": [
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "09:13 - 18:23",
                        "09:13 - 18:23",
                        "09:13 - 18:23"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:33 - 20:12",
                        "07:33 - 20:12",
                        "07:33 - 20:12"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:32 - 13:51",
                        "09:32 - 13:51",
                        "09:32 - 13:51"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "07:10 - 20:53",
                        "07:10 - 20:53",
                        "07:10 - 20:53"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "08:53 - 11:15",
                        "08:53 - 11:15",
                        "08:53 - 11:15"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:51 - 10:55",
                        "07:51 - 10:55",
                        "07:51 - 10:55"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "09:58 - 14:11",
                        "09:58 - 14:11",
                        "09:58 - 14:11"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "06:49 - 13:45",
                        "06:49 - 13:45",
                        "06:49 - 13:45"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:41 - 11:52",
                        "09:41 - 11:52",
                        "09:41 - 11:52"
                    ]
                }
            ]
        }
    ],
    "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": 19,
    "name": "Jose Roob",
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE",
        "position": {
            "latitude": 1.54361,
            "longitude": 0.45645
        }
    },
    "allow_comments": true,
    "offers": [
        {
            "id": 19,
            "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": false,
    "delivery_use_intervals": true,
    "categories": [
        {
            "id": 16,
            "name": "Devon Rutherford",
            "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": "Mollitia consequuntur qui in dolorum ducimus et dignissimos est doloremque doloremque."
                },
                "description": {
                    "en": "Et at aut voluptates autem voluptas autem. Suscipit perspiciatis nulla architecto earum sunt. Beatae esse quaerat quam quis ex."
                },
                "url": {
                    "en": "https://emard.info/corrupti-consequatur-deleniti-omnis-nisi-et.html"
                }
            }
        },
        {
            "id": 18,
            "name": "Jarrett Lueilwitz 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": "Odio recusandae in sed velit odio sequi aut commodi doloribus illo."
                },
                "description": {
                    "en": "Laudantium molestias recusandae dolores quo sed et. A quibusdam perspiciatis facilis quis nesciunt explicabo. Sunt reiciendis sunt ipsa qui. Officia consequuntur quod ratione voluptatem."
                },
                "url": {
                    "en": "http://www.okuneva.net/molestias-quidem-suscipit-placeat-est-nihil-numquam"
                }
            }
        },
        {
            "id": 12,
            "name": "Dagmar Hyatt",
            "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": "Ea quo nihil architecto eos et laudantium explicabo fugiat ab."
                },
                "description": {
                    "en": "Eos laborum dolores quos voluptas qui explicabo quo. Illo similique nesciunt voluptate nesciunt molestias. Porro unde hic laborum beatae voluptatem autem fuga."
                },
                "url": {
                    "en": "http://www.spencer.com/sed-consequatur-nihil-excepturi-cupiditate"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": "...",
            "category_ids": [
                13,
                12,
                12
            ]
        },
        {
            "name": "...",
            "category_ids": [
                10,
                14,
                13
            ]
        },
        {
            "name": "...",
            "category_ids": [
                10,
                13,
                13
            ]
        }
    ],
    "hours": [
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "09:25 - 11:27",
                        "09:25 - 11:27",
                        "09:25 - 11:27"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:25 - 12:48",
                        "09:25 - 12:48",
                        "09:25 - 12:48"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "08:24 - 12:36",
                        "08:24 - 12:36",
                        "08:24 - 12:36"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "07:34 - 21:41",
                        "07:34 - 21:41",
                        "07:34 - 21:41"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:44 - 12:57",
                        "09:44 - 12:57",
                        "09:44 - 12:57"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "08:40 - 13:31",
                        "08:40 - 13:31",
                        "08:40 - 13:31"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "07:44 - 11:11",
                        "07:44 - 11:11",
                        "07:44 - 11:11"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "06:14 - 18:29",
                        "06:14 - 18:29",
                        "06:14 - 18:29"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:41 - 14:22",
                        "07:41 - 14:22",
                        "07:41 - 14: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"
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.5.0 stable