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": 10,
    "name": "Marley Altenwerth",
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE"
    },
    "allow_comments": false,
    "offers": [
        {
            "id": 17,
            "name": "Black Friday"
        },
        {
            "id": 17,
            "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": true
        }
    },
    "allow_orders": false,
    "delivery_use_intervals": false,
    "categories": [
        {
            "id": 12,
            "name": "Parker Pagac",
            "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": "Rerum quasi fugiat ut quia qui blanditiis autem qui omnis veritatis."
                },
                "description": {
                    "en": "Unde labore quis consequatur. Illo voluptatem aut nulla rerum. Neque accusamus aspernatur quos enim."
                },
                "url": {
                    "en": "http://luettgen.com/ea-quos-quis-ut-ad-facilis"
                }
            }
        },
        {
            "id": 13,
            "name": "Reagan Roob",
            "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 veniam laudantium velit enim dolorem nostrum voluptates non sunt architecto."
                },
                "description": {
                    "en": "Eos illo ex eos beatae sapiente. Ea perspiciatis dolores molestiae repellat aut voluptatem magni. Sed inventore accusamus natus quisquam ducimus culpa et quidem."
                },
                "url": {
                    "en": "http://www.bayer.org/dolore-amet-voluptas-aut-consequatur-sint-repudiandae-quo-iusto"
                }
            }
        },
        {
            "id": 11,
            "name": "Norberto Pagac PhD",
            "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": "Asperiores aliquam quam voluptatibus enim perferendis deleniti ab reiciendis sit quis."
                },
                "description": {
                    "en": "Dolorem sequi quis soluta voluptatem officia. Quam dolores libero ad aut magni qui culpa. Voluptatem facere pariatur quia saepe. Rerum et eius adipisci qui ullam."
                },
                "url": {
                    "en": "http://www.pagac.net/ratione-enim-quidem-et-ut-reiciendis"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": "...",
            "category_ids": [
                19,
                19,
                14
            ]
        },
        {
            "name": "...",
            "category_ids": [
                15,
                15,
                13
            ]
        },
        {
            "name": "...",
            "category_ids": [
                12,
                16,
                14
            ]
        }
    ],
    "currency": "EUR"
}

Response

When returned in a response.

Example 1

{
    "id": 15,
    "name": "Theresia Wisoky II",
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE",
        "position": {
            "latitude": 1.54361,
            "longitude": 0.45645
        }
    },
    "allow_comments": true,
    "offers": [
        {
            "id": 14,
            "name": "Black Friday"
        },
        {
            "id": 15,
            "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": true,
    "categories": [
        {
            "id": 18,
            "name": "Prof. Valentin Schneider Jr.",
            "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": "Harum quia dolores eum excepturi ducimus est aut rerum."
                },
                "description": {
                    "en": "Aut aut numquam dolores quo quis non tempora. Iste veritatis molestiae aut ut. Dolorem occaecati iste aut voluptatibus. Quis voluptatibus dolorem earum quae sunt. Est nihil at a suscipit quo."
                },
                "url": {
                    "en": "http://streich.com/nesciunt-distinctio-aut-id-repudiandae"
                }
            }
        },
        {
            "id": 16,
            "name": "Mr. Terrill Turner",
            "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": "Et et explicabo ipsam iusto."
                },
                "description": {
                    "en": "Qui nobis et vitae fuga odio autem. Et autem quia ex commodi. Voluptatem itaque maiores distinctio aperiam omnis vel. Provident corporis dicta earum praesentium."
                },
                "url": {
                    "en": "http://bartoletti.com/"
                }
            }
        },
        {
            "id": 18,
            "name": "Prof. Jason Yost PhD",
            "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": "Non dicta culpa ducimus aut voluptatem voluptatem perspiciatis rerum ratione facilis."
                },
                "description": {
                    "en": "Fugiat blanditiis nostrum ipsa. Odit quaerat iure eius dolores tempora enim. Excepturi qui eveniet et et sunt."
                },
                "url": {
                    "en": "http://hegmann.com/ducimus-iure-adipisci-quia-architecto.html"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": "...",
            "category_ids": [
                12,
                14,
                18
            ]
        },
        {
            "name": "...",
            "category_ids": [
                13,
                11,
                13
            ]
        },
        {
            "name": "...",
            "category_ids": [
                16,
                13,
                15
            ]
        }
    ],
    "currency": "EUR"
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.5.0 stable