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/13/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: 3638

[
    {
        "name": "Alia Stracke",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "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": false
        },
        "seo": {
            "title": "Voluptas ut magni in adipisci qui necessitatibus saepe.",
            "description": "Repellat ut labore unde voluptas. Illo unde numquam voluptatum eaque sed. Veniam ad culpa perspiciatis ab. Et vel iusto ex voluptas assumenda voluptatem.",
            "url": "http://west.com/eos-voluptatum-cupiditate-magnam-beatae-facilis-debitis-debitis-sit.html"
        }
    },
    {
        "name": "Peyton Koepp",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "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": false
        },
        "seo": {
            "title": "Non incidunt commodi id quis reiciendis cupiditate.",
            "description": "Recusandae aliquid est nisi ipsa soluta aliquid maxime. Est qui corporis neque molestiae. Placeat non asperiores ipsum maiores itaque. Aut nobis asperiores et ut cum est dignissimos.",
            "url": "http://www.buckridge.info/recusandae-dicta-veritatis-quas-et"
        }
    },
    {
        "name": "Nova Quitzon",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "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": false
        },
        "seo": {
            "title": "Delectus voluptas eveniet eaque debitis reiciendis alias veritatis dolores et.",
            "description": "Laborum ut voluptatum et quis repudiandae. Dolorem facere et culpa qui fuga aliquid est accusamus. Est saepe repudiandae cumque quia incidunt quod quaerat.",
            "url": "http://hane.com/rem-ipsa-similique-eum-tempore-distinctio-aut-nam"
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.6.0)
1.5.0 stable