Upload a category group overview image

POST /company/categorygroups/@category_group_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
category_group_id	Int	The ID of the category group you want to upload a photo 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/categorygroups/17/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

A category group groups multiple categories of a shop. These categories will be displayed on the webshop in a group. You can include the same categories in multiple groups. If a category is not inside a group, it will get displayed at the bottom of the webshop. If a shop doesn't have a lot of categories, it might be better to not define any groups.

Field	Type	Description
name	[Language: String]	Name of the category group
active	Bool	Set active status of category group
category_ids	[Int]	Category IDs that are children to this category group
id	Int	ID of the category group
overview_image	Image?	Nullable.
uuid	String	Optional. A unique ID for this category group. You can choose your own ID's as long as they are unique within a shop. If you don't set an ID, we will generate a UUID.
order	Int	Optional. The order for this category group

Example response 1

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


{
    "name": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": true,
    "category_ids": [
        18,
        19,
        15
    ],
    "id": 18,
    "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": 15,
        "white_background": false
    },
    "uuid": "...",
    "order": 18
}

1.9.0 stable