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.5.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
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: 6756

{
    "name": "Rosamond Nader",
    "active": true,
    "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": "Jazlyn Larson",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "only_order_in_store": false,
            "id": 12,
            "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": "Voluptatem id ipsam ipsa similique natus molestiae aut aut repudiandae."
                },
                "description": {
                    "en": "In recusandae iusto et numquam voluptatibus ducimus tempore eum. Nisi suscipit omnis nemo rem aut. Sint commodi et quisquam occaecati explicabo."
                },
                "url": {
                    "en": "http://www.hammes.biz/rerum-impedit-quo-est-qui-consectetur-omnis-expedita.html"
                }
            }
        },
        {
            "name": "Ms. Idell Moen DVM",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "only_order_in_store": false,
            "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": false
            },
            "seo": {
                "title": {
                    "en": "Inventore fuga labore quisquam ut et vero."
                },
                "description": {
                    "en": "Quae expedita quis officiis ut. Quia et ipsa qui nihil voluptas est. Dolor beatae sed excepturi unde nobis praesentium."
                },
                "url": {
                    "en": "http://www.sanford.com/"
                }
            }
        },
        {
            "name": "Prof. Lenora Connelly",
            "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": "Optio qui assumenda cumque sint sunt assumenda dolores quia facere."
                },
                "description": {
                    "en": "Non laborum id pariatur quis. Doloribus et voluptate culpa. Animi molestiae saepe perspiciatis illo. Maiores laudantium qui a nisi ut voluptas voluptatem."
                },
                "url": {
                    "en": "http://www.doyle.com/sit-est-et-eaque-rerum-id-iure-dolorem-deleniti.html"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "category_ids": [
                11,
                17,
                19
            ],
            "uuid": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "category_ids": [
                11,
                18,
                10
            ],
            "uuid": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "category_ids": [
                12,
                12,
                12
            ],
            "uuid": "..."
        }
    ],
    "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": 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
    }
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.5.0 stable