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/16/avatar HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.0.1
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
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.

Example response 1

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

{
    "name": "Ms. Cheyenne Romaguera Jr.",
    "active": false,
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE",
        "position": {
            "latitude": 1.54361,
            "longitude": 0.45645
        }
    },
    "allow_comments": true,
    "allow_orders": false,
    "delivery_use_intervals": true,
    "categories": [
        {
            "name": "Lois Pfeffer Sr.",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "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": true
            },
            "seo": {
                "title": {
                    "en": "Rerum aliquid ut ipsum et debitis quaerat quam quos."
                },
                "description": {
                    "en": "Nemo libero repudiandae voluptate modi eum est vitae. Nemo dolor ratione suscipit vel et saepe nam error. Et officiis ad et consequuntur."
                },
                "url": {
                    "en": "https://sanford.com/et-totam-aut-animi-est-dolores-aspernatur.html"
                }
            }
        },
        {
            "name": "Anastasia Turcotte",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "only_order_in_store": false,
            "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": false
            },
            "seo": {
                "title": {
                    "en": "Eius sequi placeat illo explicabo labore voluptatem doloribus."
                },
                "description": {
                    "en": "Aut enim sunt quo voluptatem ea nulla cumque. Aut consequatur amet recusandae aliquam tempore explicabo. Voluptatum vel culpa eum. Illum est quia cum vel non rerum fugit."
                },
                "url": {
                    "en": "http://www.wyman.info/consequuntur-ea-magnam-ut-quaerat-architecto-hic"
                }
            }
        },
        {
            "name": "Kris Hodkiewicz",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "only_order_in_store": false,
            "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": "Et maiores quibusdam architecto ullam ab blanditiis."
                },
                "description": {
                    "en": "Quibusdam non perferendis sequi qui. Incidunt similique vero quia. Fugiat praesentium consectetur nam ipsam."
                },
                "url": {
                    "en": "http://www.hudson.com/"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "category_ids": [
                16,
                15,
                18
            ]
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "category_ids": [
                13,
                12,
                18
            ]
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "category_ids": [
                16,
                10,
                12
            ]
        }
    ],
    "id": 19,
    "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
    }
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.0.1 stable