Upload a category banner

POST /company/categories/@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 category 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 Category banner upload

POST /company/categories/272/banner HTTP/1.1
Host: api.bakeronline.be
Authorization: Bearer 0b6417bd4de0d3b5eb7cb937dbddd5022e45003b68d7fa3f6dc4a12de222304827d480c35e894afe983d26ccf2c67f1ddba8fcb3e355c0a338da53de442e7e3db8f0107772931a0e1f1144accaea46c9699d42910cede653d7cb47e600e2361e20cb851f
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="file"; filename="test.png"
Content-Type: image/jpeg

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

Example request 2 Category banner extension check

POST /company/categories/@id/banner HTTP/1.1
Host: api.bakeronline.be
Authorization: Bearer 0b6417bd4de0d3b5eb7cb937dbddd5022e45003b68d7fa3f6dc4a12de222304827d480c35e894afe983d26ccf2c67f1ddba8fcb3e355c0a338da53de442e7e3db8f0107772931a0e1f1144accaea46c9699d42910cede653d7cb47e600e2361e20cb851f
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="file"; filename="test.txt"
Content-Type: image/jpeg

...<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
id Int ID of the category
banner Image? Nullable.
seo company.SeoData Optional. The category's webpage search engine metatags

Example response 1 Category banner upload

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

{
    "id": 272,
    "name": {
        "nl": "Cyan"
    },
    "description": {
        "nl": "This is a random description"
    },
    "banner": {
        "resolutions": [
            {
                "src": "https://bakeronline.be/uploads/temp-uploads/v4/test.png",
                "width": 700,
                "height": 467
            }
        ]
    },
    "active": true,
    "only_order_in_store": false,
    "seo": {
        "title": [],
        "description": [],
        "url": []
    }
}

Example response 2 Category banner extension check

HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
Content-Length: 124

[
    {
        "code": "missing_field",
        "message": "Field id is required",
        "field": "parameters.id"
    }
]
1.5.0 stable