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
offers [Offer.simple] Array of Offer.simple
images [String: Image] Dictionary of Image with keys of type String
allow_comments Bool A boolean value
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 HoursInfo Information about opening hours and other delivery method hours
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

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
offers [Offer.simple] Array of Offer.simple
images [String: Image] Dictionary of Image with keys of type String
allow_comments Bool A boolean value
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 HoursInfo Information about opening hours and other delivery method hours
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

Examples

Request

When used inside a request.

Example 1

{
    "id": 15,
    "name": "Joel Bayer",
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE"
    },
    "offers": [
        {
            "id": 16,
            "name": "...",
            "items": [
                {
                    "type": "product",
                    "item_id": 10,
                    "percentage": 12,
                    "minimum": 18
                },
                {
                    "type": "product",
                    "item_id": 17,
                    "percentage": 14,
                    "minimum": 14
                },
                {
                    "type": "product",
                    "item_id": 15,
                    "percentage": 11,
                    "minimum": 19
                }
            ]
        },
        {
            "id": 10,
            "name": "...",
            "items": [
                {
                    "type": "product",
                    "item_id": 11,
                    "percentage": 15,
                    "minimum": 19
                },
                {
                    "type": "product",
                    "item_id": 11,
                    "percentage": 10,
                    "minimum": 14
                },
                {
                    "type": "product",
                    "item_id": 18,
                    "percentage": 12,
                    "minimum": 11
                }
            ]
        },
        {
            "id": 14,
            "name": "...",
            "items": [
                {
                    "type": "product",
                    "item_id": 15,
                    "percentage": 17,
                    "minimum": 10
                },
                {
                    "type": "product",
                    "item_id": 16,
                    "percentage": 19,
                    "minimum": 16
                },
                {
                    "type": "product",
                    "item_id": 13,
                    "percentage": 12,
                    "minimum": 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": true
        }
    },
    "allow_comments": true,
    "allow_orders": true,
    "delivery_use_intervals": false,
    "categories": [
        {
            "id": 12,
            "name": "Mr. Derek Koss",
            "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": "Quos ut perferendis quam ad aut sed omnis maiores temporibus temporibus."
                },
                "description": {
                    "en": "Possimus qui hic ullam dignissimos velit. Sed ut omnis atque odit earum et consequuntur cum. Molestias laudantium odio repellendus. Ipsam aut eum mollitia et maxime."
                },
                "url": {
                    "en": "https://www.corkery.net/quo-corrupti-maxime-dolores-quis"
                }
            }
        },
        {
            "id": 18,
            "name": "Antwan Monahan",
            "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": "Sint unde officia nesciunt iste quidem repellat alias fugiat."
                },
                "description": {
                    "en": "Sequi magnam doloremque laudantium provident nam dolore repellat. Quia quia minus cum aut."
                },
                "url": {
                    "en": "http://zulauf.com/corporis-consectetur-tenetur-rerum-minima-sed"
                }
            }
        },
        {
            "id": 12,
            "name": "Daron Runte",
            "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": "Numquam cupiditate tenetur itaque quia minus sequi aut corrupti."
                },
                "description": {
                    "en": "A saepe nobis hic officiis praesentium. Maiores a in dolor sequi hic. Ad necessitatibus cum excepturi error. Laboriosam sed dicta laboriosam eaque in dolorem iste. Aut non voluptatem dolorum vero et."
                },
                "url": {
                    "en": "https://keebler.com/fugiat-odit-quas-tempore-et-est-autem-quibusdam.html"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": "...",
            "category_ids": [
                10,
                13,
                18
            ]
        },
        {
            "name": "...",
            "category_ids": [
                11,
                11,
                10
            ]
        },
        {
            "name": "...",
            "category_ids": [
                11,
                10,
                18
            ]
        }
    ],
    "hours": {
        "open": [
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            },
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            },
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            }
        ],
        "takeout": [
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            },
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            },
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            }
        ],
        "delivery": [
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            },
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            },
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            }
        ],
        "latch": [
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            },
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            },
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            }
        ]
    },
    "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"
        }
    ]
}

Response

When returned in a response.

Example 1

{
    "id": 11,
    "name": "Waylon Funk",
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE",
        "position": {
            "latitude": 1.54361,
            "longitude": 0.45645
        }
    },
    "offers": [
        {
            "id": 16,
            "name": "...",
            "items": [
                {
                    "type": "product",
                    "item_id": 12,
                    "percentage": 11,
                    "minimum": 19
                },
                {
                    "type": "product",
                    "item_id": 19,
                    "percentage": 18,
                    "minimum": 12
                },
                {
                    "type": "product",
                    "item_id": 11,
                    "percentage": 12,
                    "minimum": 12
                }
            ]
        },
        {
            "id": 18,
            "name": "...",
            "items": [
                {
                    "type": "product",
                    "item_id": 14,
                    "percentage": 11,
                    "minimum": 17
                },
                {
                    "type": "product",
                    "item_id": 12,
                    "percentage": 16,
                    "minimum": 19
                },
                {
                    "type": "product",
                    "item_id": 12,
                    "percentage": 16,
                    "minimum": 11
                }
            ]
        },
        {
            "id": 15,
            "name": "...",
            "items": [
                {
                    "type": "product",
                    "item_id": 14,
                    "percentage": 17,
                    "minimum": 15
                },
                {
                    "type": "product",
                    "item_id": 10,
                    "percentage": 14,
                    "minimum": 16
                },
                {
                    "type": "product",
                    "item_id": 18,
                    "percentage": 16,
                    "minimum": 12
                }
            ]
        }
    ],
    "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_comments": true,
    "allow_orders": false,
    "delivery_use_intervals": false,
    "categories": [
        {
            "id": 12,
            "name": "Maribel Hauck V",
            "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": "Maxime quos totam enim dolore expedita officiis reiciendis commodi."
                },
                "description": {
                    "en": "Error voluptas enim nisi quaerat voluptatibus. Dolorem perferendis eos est sapiente repudiandae. Alias distinctio eos totam."
                },
                "url": {
                    "en": "http://hackett.com/placeat-ut-atque-veniam-consequatur-aut-incidunt-eum.html"
                }
            }
        },
        {
            "id": 18,
            "name": "Jordon Douglas",
            "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": "Aut architecto cupiditate cumque sunt at excepturi occaecati voluptates consequatur totam."
                },
                "description": {
                    "en": "Cum omnis rerum et eius dolores. Totam eum illo magnam. Consequuntur hic possimus et harum sunt deserunt."
                },
                "url": {
                    "en": "http://gutkowski.biz/nostrum-commodi-modi-voluptate-non.html"
                }
            }
        },
        {
            "id": 11,
            "name": "Preston Keeling 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": false
            },
            "seo": {
                "title": {
                    "en": "Expedita voluptas qui modi eos odio minus mollitia veniam et."
                },
                "description": {
                    "en": "Est et veritatis id facilis veritatis. Sint officia sunt suscipit laudantium. Sed aspernatur fuga officiis itaque ut. Non numquam sit quas eum omnis repudiandae eos."
                },
                "url": {
                    "en": "http://www.willms.com/maxime-nam-et-similique-minus"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": "...",
            "category_ids": [
                18,
                12,
                12
            ]
        },
        {
            "name": "...",
            "category_ids": [
                14,
                10,
                14
            ]
        },
        {
            "name": "...",
            "category_ids": [
                15,
                14,
                16
            ]
        }
    ],
    "hours": {
        "open": [
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            },
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            },
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            }
        ],
        "takeout": [
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            },
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            },
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            }
        ],
        "delivery": [
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            },
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            },
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            }
        ],
        "latch": [
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            },
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            },
            {
                "start": 1,
                "end": 1,
                "times": [
                    "...",
                    "...",
                    "..."
                ]
            }
        ]
    },
    "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"
        }
    ]
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
0.2.1 stable