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/14 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.7.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
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: 7068

{
    "name": "Vivianne White",
    "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": true,
    "delivery_use_intervals": true,
    "allow_invoices": true,
    "allow_order_comments": true,
    "allow_product_comments": true,
    "takeout_use_intervals": false,
    "allow_order_messages": false,
    "categories": [
        {
            "name": "Marlene Block",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "only_order_in_store": false,
            "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": "Autem ipsum vero ut sunt fuga esse quibusdam ut tempore soluta."
                },
                "description": {
                    "en": "Neque iusto non nihil est laborum quo. Ut iusto saepe voluptatibus ratione. Nihil voluptas ut facere. Libero eveniet facilis exercitationem similique et numquam."
                },
                "url": {
                    "en": "http://www.casper.com/"
                }
            }
        },
        {
            "name": "Prof. Jaqueline Veum",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "only_order_in_store": true,
            "id": 13,
            "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": "Voluptatem cupiditate natus saepe ut corporis autem."
                },
                "description": {
                    "en": "Ut inventore iure harum esse laudantium quasi doloribus. Repudiandae perferendis soluta ut repudiandae. Quia qui et saepe inventore temporibus facilis consequatur. Optio sit aut corrupti itaque."
                },
                "url": {
                    "en": "http://labadie.com/ab-laboriosam-ea-dolor-nam.html"
                }
            }
        },
        {
            "name": "Elissa White IV",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "only_order_in_store": true,
            "id": 19,
            "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": "Inventore quam quia doloribus ea aliquid vel neque."
                },
                "description": {
                    "en": "Aperiam cumque pariatur velit culpa. Dolorum inventore distinctio dignissimos officia nostrum unde at ut. Sit hic eaque voluptatibus eos. Officiis doloremque quam qui tempora aut aliquid voluptas."
                },
                "url": {
                    "en": "http://www.mccullough.net/"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "category_ids": [
                17,
                19,
                16
            ],
            "id": 11,
            "uuid": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "category_ids": [
                17,
                12,
                10
            ],
            "id": 15,
            "uuid": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "category_ids": [
                17,
                18,
                18
            ],
            "id": 12,
            "uuid": "..."
        }
    ],
    "currency": "...",
    "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": true
    },
    "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.7.0 stable