company.Shop.detailed

Request

Fields when send to the api inside a request.

Field Type Description
name String Name of the shop (not translateable for now)
active Bool A boolean value
address Address.detailed An address
allow_comments Bool A boolean value
allow_orders Bool A boolean value
delivery_use_intervals Bool A boolean value
category_ids [Int] List of the categories (in the right order) of all the categories visible for the shop
category_groups [company.CategoryGroup] List of the category groups linked to the shop. More information can be found on the category group documentation page.

Response

Fields when returned by the api in a response.

Field Type Description
name String Name of the shop (not translateable for now)
active Bool A boolean value
address Address.detailed An address
allow_comments Bool A boolean value
allow_orders Bool A boolean value
delivery_use_intervals Bool A boolean value
categories [company.Category.simple] List of the categories of all the categories visible for the shop
category_groups [company.CategoryGroup] List of the category groups linked to the shop. More information can be found on the category group documentation page.
id Int ID of the shop
avatar Image? Nullable.
banner Image? Nullable.

Examples

Request

When used inside a request.

Example 1

{
    "id": 2321,
    "name": "Mad Batters",
    "active": true,
    "address": {
        "street": "Adamlaan",
        "nr": "66",
        "zipcode": "3570",
        "city": "Kortrijk",
        "country": "BE",
        "position": {
            "latitude": 51.260197,
            "longitude": 4.402771
        }
    },
    "avatar": null,
    "banner": {
        "resolutions": [
            {
                "src": "https://bakeronline.be/uploads/banner/2321/1300x315/bakkerij-debuf.jpg",
                "width": 450,
                "height": 300
            },
            {
                "src": "https://bakeronline.be/uploads/banner/2321/900x250/bakkerij-debuf.jpg",
                "width": 450,
                "height": 300
            }
        ]
    },
    "allow_comments": true,
    "allow_orders": true,
    "delivery_use_intervals": false,
    "categories": [],
    "category_groups": []
}

Response

When returned in a response.

Example 1

{
    "id": 2322,
    "name": "Cut the Cake",
    "active": true,
    "address": {
        "street": "Antoinestraat",
        "nr": "99",
        "zipcode": "3700",
        "city": "Bree",
        "country": "BE",
        "position": {
            "latitude": 50.8503396,
            "longitude": 4.3517103
        }
    },
    "avatar": {
        "resolutions": [
            {
                "src": "https://bakeronline.be/uploads/shop-avatars/2322/180x180/bakkerij-van-hecke-eke-nazareth.jpg",
                "width": 178,
                "height": 178
            }
        ]
    },
    "banner": {
        "resolutions": [
            {
                "src": "https://bakeronline.be/uploads/banner/2322/1300x315/bakkerij-laurens.jpg",
                "width": 199,
                "height": 300
            },
            {
                "src": "https://bakeronline.be/uploads/banner/2322/900x250/bakkerij-laurens.jpg",
                "width": 199,
                "height": 300
            }
        ]
    },
    "allow_comments": true,
    "allow_orders": true,
    "delivery_use_intervals": false,
    "categories": [],
    "category_groups": []
}
1.5.0 stable