Upload a category overview image

POST /company/categories/@id/overview

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 category you want to upload an overview image 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/categories/18/overview HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.9.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	[Language: String]	Translated category name
description	[Language: String]	Description of this category
active	Bool	A boolean value
only_order_in_store	Bool	Whether this product can only get ordered in the store with a separate UI for the shop employees, and not in the public webshop
code	String?	Nullable. A custom code. You can set this to your own code and use this field to map your categories to Bakeronline categories
id	Int	ID of the category
banner	Image?	Nullable.
overview_image	Image?	Nullable.
seo	company.SeoData	Optional. The category's webpage search engine metatags

Example response 1

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


{
    "name": "Ellis Boehm",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": true,
    "only_order_in_store": true,
    "code": "...",
    "id": 15,
    "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
            }
        ],
        "file_id": 13,
        "white_background": false
    },
    "overview_image": {
        "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
            }
        ],
        "file_id": 13,
        "white_background": false
    },
    "seo": {
        "title": {
            "en": "Praesentium tenetur inventore officia accusamus dicta porro et sed facere."
        },
        "description": {
            "en": "Nobis explicabo dolorum excepturi quisquam a. Dicta pariatur amet aut quo id enim est est. Sit minima esse enim enim aut voluptatum. Excepturi beatae aut vel distinctio."
        },
        "url": {
            "en": "http://www.emmerich.org/"
        }
    }
}

1.9.0 stable