Shop.detailed

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

Examples

Request

When used inside a request.

Example 1

{
    "id": 16,
    "name": "Prof. Phyllis Morar MD",
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE"
    },
    "allow_comments": true,
    "offers": [
        {
            "id": 14,
            "name": "Black Friday"
        },
        {
            "id": 16,
            "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": false
        }
    },
    "allow_orders": true,
    "delivery_use_intervals": true,
    "categories": [
        {
            "id": 17,
            "name": "Devon Wisozk",
            "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": "Molestiae sint possimus praesentium et et adipisci."
                },
                "description": {
                    "en": "Fugit sit inventore sit aspernatur esse enim sint dolorem. Odio aliquam quidem error eaque quia illo. Enim est et nihil officia. Alias ullam voluptatem voluptas ut consequatur."
                },
                "url": {
                    "en": "https://quitzon.com/rerum-eum-est-fugit-quia-eaque.html"
                }
            }
        },
        {
            "id": 11,
            "name": "Madyson Raynor",
            "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": "Voluptatum aliquid sit corrupti voluptates ratione qui dicta."
                },
                "description": {
                    "en": "Voluptatibus cupiditate enim occaecati molestias consequatur. Accusamus deserunt ut dolores amet facere omnis ea enim. Aperiam quod aut facere tempora voluptate eos."
                },
                "url": {
                    "en": "http://kuphal.net/"
                }
            }
        },
        {
            "id": 15,
            "name": "Dr. Carmelo Greenfelder I",
            "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": "Voluptas quia adipisci aut eveniet rem ut voluptas quia."
                },
                "description": {
                    "en": "Sit ad et nisi aperiam placeat vel. Id et beatae tempora placeat autem commodi quia. Possimus non non et expedita sit qui et. Dolorum qui sunt odio sint."
                },
                "url": {
                    "en": "http://cronin.com/quo-ratione-voluptatem-aut-quos"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": "...",
            "category_ids": [
                14,
                11,
                12
            ]
        },
        {
            "name": "...",
            "category_ids": [
                13,
                14,
                12
            ]
        },
        {
            "name": "...",
            "category_ids": [
                14,
                12,
                13
            ]
        }
    ],
    "currency": "EUR"
}

Response

When returned in a response.

Example 1

{
    "id": 19,
    "name": "Lauriane Morissette",
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE",
        "position": {
            "latitude": 1.54361,
            "longitude": 0.45645
        }
    },
    "allow_comments": false,
    "offers": [
        {
            "id": 12,
            "name": "Black Friday"
        },
        {
            "id": 15,
            "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": true,
    "delivery_use_intervals": false,
    "categories": [
        {
            "id": 18,
            "name": "Randy Skiles",
            "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": "Omnis enim et deleniti et expedita."
                },
                "description": {
                    "en": "Sint non aliquam sed. Minus ea labore et dolores eum consequatur non. Quo praesentium animi voluptatem maiores facilis. Cumque voluptatem sunt rerum error non ut."
                },
                "url": {
                    "en": "http://www.lakin.com/suscipit-laudantium-minima-et-odit"
                }
            }
        },
        {
            "id": 10,
            "name": "Carolyne Collins",
            "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": "Blanditiis sit non sit voluptatem consequatur velit optio veniam aperiam."
                },
                "description": {
                    "en": "Rerum harum beatae sint corporis voluptatibus in quia. Omnis eius eos impedit consequatur. Ut dicta sit ex. Voluptate expedita dignissimos reiciendis quae rerum beatae."
                },
                "url": {
                    "en": "http://kirlin.com/debitis-perferendis-animi-et-nemo-iusto-eos-autem"
                }
            }
        },
        {
            "id": 11,
            "name": "Dr. Kianna Wintheiser I",
            "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": "Delectus a necessitatibus in quo aliquid eius quis nihil."
                },
                "description": {
                    "en": "Ea assumenda voluptatum beatae distinctio sint a. Illum placeat quae modi commodi. Fuga reiciendis dicta debitis voluptatem qui sed."
                },
                "url": {
                    "en": "https://macejkovic.com/qui-aut-quidem-dolore-iure-consequuntur-est-repellendus.html"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": "...",
            "category_ids": [
                17,
                17,
                10
            ]
        },
        {
            "name": "...",
            "category_ids": [
                18,
                10,
                17
            ]
        },
        {
            "name": "...",
            "category_ids": [
                10,
                16,
                12
            ]
        }
    ],
    "currency": "EUR"
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.5.0 stable