Upload a shop banner

POST /company/shops/@id/banner

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 a banner 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/14/banner HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 0.3.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: 6721

{
    "name": "Vaughn Emard",
    "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": "Rhiannon Romaguera",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "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": "Eos ipsum id corporis incidunt dolorum repellat."
                },
                "description": {
                    "en": "Expedita iure saepe pariatur qui. Ut ea repellendus impedit ut provident est commodi dolorum. Aut fuga accusantium quia tempora. Est culpa sapiente cupiditate fugiat ut esse."
                },
                "url": {
                    "en": "http://baumbach.org/harum-voluptatem-id-rerum-quia-quia-distinctio-et"
                }
            }
        },
        {
            "name": "Edmond Pollich",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "only_order_in_store": true,
            "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": "Cupiditate rem non atque nihil cum quisquam pariatur et."
                },
                "description": {
                    "en": "Sint dolor qui repellat perferendis quae. Reprehenderit est qui quam amet et alias. Animi iusto perspiciatis doloribus non et et. Debitis magni laudantium voluptas qui qui quasi assumenda omnis."
                },
                "url": {
                    "en": "http://gulgowski.com/sit-atque-est-vel-iste-quam-qui-qui.html"
                }
            }
        },
        {
            "name": "Mozelle Hagenes",
            "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": false
            },
            "seo": {
                "title": {
                    "en": "Similique totam officiis quia aliquid qui animi quo libero."
                },
                "description": {
                    "en": "Amet dolorum ullam quia. Officiis et placeat pariatur. Aliquid repudiandae quod adipisci nobis dolor assumenda. Aliquid optio neque optio minima."
                },
                "url": {
                    "en": "http://www.rath.com/"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "category_ids": [
                14,
                12,
                12
            ]
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "category_ids": [
                11,
                12,
                12
            ]
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "category_ids": [
                15,
                13,
                10
            ]
        }
    ],
    "id": 11,
    "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)
0.3.0 stable