Create a categorygroup

POST /company/shops/@shop_id/categorygroups

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
shop_id Int The ID of the shop to create a new category group for

Body

Pass the following properties via application/json or form encoding in the body of the request.

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
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 request 1 

POST /company/shops/16/categorygroups HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.10.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 206

{
    "name": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": false,
    "category_ids": [
        14,
        12,
        19
    ],
    "uuid": "...",
    "order": 11
}

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": false,
    "category_ids": [
        10,
        16,
        18
    ],
    "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": 18,
        "white_background": true
    },
    "uuid": "...",
    "order": 18
}
This is a development version Do not use this version in production
1.10.0 development