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] Array of Offer
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] Array of Offer
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": 16,
    "name": "Remington Kuvalis",
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE"
    },
    "allow_comments": true,
    "offers": [
        {
            "id": 14,
            "name": "Black Friday"
        },
        {
            "id": 13,
            "name": "Black Friday"
        },
        {
            "id": 11,
            "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": 17,
            "name": "Miss Irma Wolf",
            "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": "Beatae est ut et a iste.",
                "description": "Officia nisi praesentium officiis laboriosam porro. Veniam illo libero rerum at sapiente ullam. Consequuntur officia non est laboriosam aut assumenda. Aut illo ut consequatur.",
                "url": "http://sipes.com/alias-consectetur-dolores-at-dolore.html"
            }
        },
        {
            "id": 15,
            "name": "Iva Stoltenberg",
            "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": "Aspernatur corporis rem esse pariatur nihil architecto ducimus rerum rerum aut voluptate.",
                "description": "Aspernatur tempora possimus ad qui et quo voluptatem. Voluptates ut praesentium et labore nulla sit. Sed et dolores laboriosam qui assumenda magni.",
                "url": "http://lebsack.com/iure-quod-est-est-excepturi-quo"
            }
        },
        {
            "id": 19,
            "name": "Mr. Terrance Treutel MD",
            "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": "Soluta temporibus ex nihil maxime quo.",
                "description": "Nemo rerum repellat consectetur sapiente. Voluptatem doloribus blanditiis sapiente labore voluptatem sed aliquid eveniet. Fuga est earum id quibusdam inventore libero.",
                "url": "http://www.schulist.com/quam-occaecati-in-ipsam-dolores-doloremque-quia-ipsam"
            }
        }
    ],
    "category_groups": [
        {
            "name": "...",
            "category_ids": [
                15,
                19,
                15
            ]
        },
        {
            "name": "...",
            "category_ids": [
                14,
                19,
                19
            ]
        },
        {
            "name": "...",
            "category_ids": [
                19,
                18,
                18
            ]
        }
    ],
    "hours": [
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "07:22 - 16:37",
                        "07:22 - 16:37",
                        "07:22 - 16:37"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "06:41 - 11:27",
                        "06:41 - 11:27",
                        "06:41 - 11:27"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "08:25 - 13:13",
                        "08:25 - 13:13",
                        "08:25 - 13:13"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "09:49 - 20:24",
                        "09:49 - 20:24",
                        "09:49 - 20:24"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:58 - 14:53",
                        "09:58 - 14:53",
                        "09:58 - 14:53"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "09:55 - 11:28",
                        "09:55 - 11:28",
                        "09:55 - 11:28"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "09:58 - 12:22",
                        "09:58 - 12:22",
                        "09:58 - 12:22"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:45 - 20:35",
                        "07:45 - 20:35",
                        "07:45 - 20:35"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "06:58 - 12:27",
                        "06:58 - 12:27",
                        "06:58 - 12:27"
                    ]
                }
            ]
        }
    ],
    "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": 14,
    "name": "Alison Langworth",
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE",
        "position": {
            "latitude": 1.54361,
            "longitude": 0.45645
        }
    },
    "allow_comments": true,
    "offers": [
        {
            "id": 13,
            "name": "Black Friday"
        },
        {
            "id": 13,
            "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": 19,
            "name": "Rory Powlowski",
            "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": "Ea fuga id incidunt mollitia magnam provident et consequatur.",
                "description": "Repudiandae molestiae non itaque. Voluptates quis vero consequatur commodi pariatur animi. Repellendus optio minus et et.",
                "url": "http://www.hamill.info/itaque-tempore-error-veniam"
            }
        },
        {
            "id": 15,
            "name": "Bria Turcotte",
            "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": "Rerum ducimus et in commodi unde distinctio commodi dolorem itaque ex.",
                "description": "Dolorem distinctio soluta quas sit eum deleniti tenetur. Dolorum qui in ut qui alias. Quaerat voluptatem est fugit nostrum est in id omnis.",
                "url": "http://www.gusikowski.org/quo-culpa-fugit-accusamus-culpa-enim-magni-qui.html"
            }
        },
        {
            "id": 14,
            "name": "Mr. Efren Konopelski 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": true
            },
            "seo": {
                "title": "Voluptatibus earum ex quia odio nihil.",
                "description": "Aut maiores facere tenetur aliquam omnis repudiandae. Sed placeat voluptatum at asperiores. Dolor enim explicabo recusandae eum maiores.",
                "url": "http://bauch.com/"
            }
        }
    ],
    "category_groups": [
        {
            "name": "...",
            "category_ids": [
                14,
                19,
                19
            ]
        },
        {
            "name": "...",
            "category_ids": [
                19,
                13,
                14
            ]
        },
        {
            "name": "...",
            "category_ids": [
                12,
                19,
                16
            ]
        }
    ],
    "hours": [
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "09:33 - 18:57",
                        "09:33 - 18:57",
                        "09:33 - 18:57"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "06:16 - 20:50",
                        "06:16 - 20:50",
                        "06:16 - 20:50"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:54 - 21:50",
                        "07:54 - 21:50",
                        "07:54 - 21:50"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "07:14 - 12:30",
                        "07:14 - 12:30",
                        "07:14 - 12:30"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:39 - 10:35",
                        "07:39 - 10:35",
                        "07:39 - 10:35"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:57 - 11:23",
                        "07:57 - 11:23",
                        "07:57 - 11:23"
                    ]
                }
            ]
        },
        {
            "name": "...",
            "description": "...",
            "type": "open",
            "hours": [
                {
                    "days": "5",
                    "times": [
                        "08:12 - 18:24",
                        "08:12 - 18:24",
                        "08:12 - 18:24"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "06:40 - 21:59",
                        "06:40 - 21:59",
                        "06:40 - 21:59"
                    ]
                },
                {
                    "days": "5",
                    "times": [
                        "07:37 - 17:43",
                        "07:37 - 17:43",
                        "07:37 - 17:43"
                    ]
                }
            ]
        }
    ],
    "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.6.0)
1.5.0 stable