Get all the category groups that belong to a shop

GET /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 get all category groups from

Example request 1

GET /company/shops/12/categorygroups HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.10.0
Accept-Language: en-US,en;q=0.5

Response

Array of company.CategoryGroup: [company.CategoryGroup]

company.CategoryGroup

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: 2693

[
    {
        "name": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "category_ids": [
            15,
            15,
            15
        ],
        "id": 17,
        "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": 19,
            "white_background": true
        },
        "uuid": "...",
        "order": 12
    },
    {
        "name": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "category_ids": [
            15,
            15,
            16
        ],
        "id": 11,
        "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
        },
        "uuid": "...",
        "order": 18
    },
    {
        "name": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "category_ids": [
            12,
            17,
            18
        ],
        "id": 14,
        "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": 16,
            "white_background": false
        },
        "uuid": "...",
        "order": 12
    }
]
This is a development version Do not use this version in production
1.10.0 development