Get all the categories that belong to a shop

GET /company/shops/@id/categories

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 Return all categories of the given shop

Example request 1

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

Response

Array of company.Category.simple: [company.Category.simple]

company.Category.simple

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

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

[
    {
        "name": "Kris Volkman",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": true,
        "id": 17,
        "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
                }
            ],
            "white_background": false
        },
        "seo": {
            "title": {
                "en": "Vero officia et non modi animi corrupti."
            },
            "description": {
                "en": "Et quisquam iste qui est. Assumenda aut consectetur consequuntur sit in voluptatum temporibus. Architecto numquam in itaque illum architecto."
            },
            "url": {
                "en": "https://wehner.org/qui-et-cumque-a-exercitationem.html"
            }
        }
    },
    {
        "name": "Dr. Ozella Quigley V",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": true,
        "id": 19,
        "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
                }
            ],
            "white_background": true
        },
        "seo": {
            "title": {
                "en": "Provident id provident voluptatum sapiente est consequatur."
            },
            "description": {
                "en": "Quasi enim id tempora error. Et aut ea sed distinctio. Qui ut qui ut qui magnam quaerat illum."
            },
            "url": {
                "en": "https://dietrich.net/doloribus-eaque-libero-est-id-odit-assumenda-rerum.html"
            }
        }
    },
    {
        "name": "Aisha Rogahn",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": true,
        "id": 14,
        "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
                }
            ],
            "white_background": true
        },
        "seo": {
            "title": {
                "en": "Et eos provident ullam et ratione."
            },
            "description": {
                "en": "Exercitationem ut vel vel tempora. Sint voluptate dolor consectetur ratione. Maiores dolorem explicabo sunt velit atque et. Debitis consequuntur at est odio neque aliquid."
            },
            "url": {
                "en": "http://www.fritsch.com/modi-consequatur-dignissimos-exercitationem-qui-suscipit-a-impedit-non"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.5.0 stable