Upload a shop avatar

POST /company/shops/@id/avatar

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 upload an avatar for

File upload

This endpoint requires uploaded files in the HTTP request. You can check the examples on the right for more information or read more about this on MDN.

Key Description
file Upload a single file

Example request 1

POST /company/shops/11/avatar HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.7.0
Accept-Language: en-US,en;q=0.5
Content-Type: multipart/form-data;boundary="boundary"

--boundary
Content-Disposition: form-data; name="single"; filename="test.png"
Content-Type: image/png

...<Binary file here depending on Content-Transfer-Encoding field>...
--boundary--

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: 7076

{
    "name": "Dr. Trey McLaughlin",
    "active": true,
    "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": false,
    "allow_product_comments": true,
    "takeout_use_intervals": true,
    "allow_order_messages": false,
    "categories": [
        {
            "name": "Dora Kutch",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "only_order_in_store": false,
            "id": 11,
            "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 placeat similique commodi accusantium ut."
                },
                "description": {
                    "en": "Suscipit quod voluptas earum blanditiis nesciunt minus. Maxime nam reprehenderit dolores nulla sed assumenda qui libero."
                },
                "url": {
                    "en": "https://www.crona.com/ad-praesentium-inventore-perferendis-voluptas-praesentium"
                }
            }
        },
        {
            "name": "Karina Metz",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "only_order_in_store": false,
            "id": 11,
            "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": "Aperiam iusto et eveniet eaque voluptatibus quia qui."
                },
                "description": {
                    "en": "Quis aut ut officia quos enim. Itaque iure qui odio. Eius tempora et delectus et laborum aut similique. Quo incidunt recusandae eum laudantium aut suscipit."
                },
                "url": {
                    "en": "http://www.lindgren.com/quibusdam-perspiciatis-natus-inventore-aut-sunt-nemo.html"
                }
            }
        },
        {
            "name": "Theodore Buckridge Jr.",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "only_order_in_store": true,
            "id": 16,
            "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": "Laboriosam quaerat dolores beatae error doloremque."
                },
                "description": {
                    "en": "Id id laborum dolorem voluptatibus. Veniam ipsa quibusdam consequatur aut minus qui architecto. Delectus et excepturi ut mollitia ut quae in. Est sit aut et commodi sit aut."
                },
                "url": {
                    "en": "https://feest.biz/aperiam-fuga-non-et-omnis-doloremque-ipsam.html"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "category_ids": [
                12,
                13,
                16
            ],
            "id": 18,
            "uuid": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "category_ids": [
                10,
                10,
                16
            ],
            "id": 12,
            "uuid": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "category_ids": [
                10,
                15,
                16
            ],
            "id": 17,
            "uuid": "..."
        }
    ],
    "currency": "...",
    "id": 15,
    "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": true
    },
    "url": "..."
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.7.0 stable