Get a shop

GET /company/shops/@id

Request

Authentication

This endpoint requires authentication.

Header Value
Authorization Set the value to Bearer + + access_token

URL parameters

Replace the @ keywords in the URL with their corresponding value.

A dictionary with fields

Field Type Description
id Int The ID of the shop you want to retrieve

Example request 1

GET /company/shops/17 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.8.0
Accept-Language: en-US,en;q=0.5

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
allow_invoices Bool A boolean value
allow_order_comments Bool A boolean value
allow_product_comments Bool A boolean value
takeout_use_intervals Bool A boolean value
allow_order_messages 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.
currency String A String value
emails Dictionary Email settings
id Int ID of the shop
avatar Image? Nullable.
banner Image? Nullable.
url String URL the shop in case it is using a platform

Example response 1

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 7144

{
    "name": "Miss Vallie Roob II",
    "active": false,
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE",
        "position": {
            "latitude": 1.54361,
            "longitude": 0.45645
        }
    },
    "allow_comments": false,
    "allow_orders": false,
    "delivery_use_intervals": false,
    "allow_invoices": true,
    "allow_order_comments": true,
    "allow_product_comments": true,
    "takeout_use_intervals": true,
    "allow_order_messages": true,
    "categories": [
        {
            "name": "Vernon Miller",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "only_order_in_store": true,
            "code": "...",
            "id": 17,
            "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": "Sed nihil eum excepturi voluptates nemo quia id odio at."
                },
                "description": {
                    "en": "Similique voluptatem aut aut saepe et repudiandae architecto. Ut nemo nulla voluptas dignissimos. Quis at ullam molestias quos ipsam tempore sed. Velit modi dolor consequuntur et."
                },
                "url": {
                    "en": "http://www.mohr.com/"
                }
            }
        },
        {
            "name": "Susie Kirlin",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "only_order_in_store": true,
            "code": "...",
            "id": 15,
            "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": "Neque dolores soluta quas ut vero adipisci."
                },
                "description": {
                    "en": "Reiciendis minus temporibus qui vero sequi. Labore iste corrupti quo illo sed id. Quibusdam maxime odit voluptatem laboriosam et. In iusto eaque et atque. Non quaerat repudiandae iusto fugiat."
                },
                "url": {
                    "en": "http://hintz.com/"
                }
            }
        },
        {
            "name": "Dr. Rex McKenzie Sr.",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "only_order_in_store": false,
            "code": "...",
            "id": 18,
            "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": "Nulla ex ut et numquam et id nemo voluptatum."
                },
                "description": {
                    "en": "Unde quam iusto consequatur quos maxime. Ut magni sunt voluptatem dolorem. Totam sed nam et. Est aliquid quis odit id."
                },
                "url": {
                    "en": "http://www.schuppe.biz/autem-commodi-minima-qui-doloribus-aspernatur-quia.html"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "category_ids": [
                11,
                14,
                12
            ],
            "id": 19,
            "uuid": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "category_ids": [
                19,
                11,
                17
            ],
            "id": 19,
            "uuid": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "category_ids": [
                10,
                15,
                18
            ],
            "id": 10,
            "uuid": "..."
        }
    ],
    "currency": "...",
    "emails": {
        "note_for_customer": "..."
    },
    "id": 14,
    "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
    },
    "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
    },
    "url": "..."
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.8.0 stable