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/10/categories HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.4.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: 3866

[
    {
        "name": "Mr. Kayley Kovacek MD",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": true,
        "id": 11,
        "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": "At cumque mollitia omnis blanditiis sed soluta aut."
            },
            "description": {
                "en": "Et animi id sequi et. Molestias repellendus quidem et sed quos est. Ab est numquam et id et suscipit ut. Officiis unde saepe quidem dolorem error itaque provident."
            },
            "url": {
                "en": "http://purdy.info/"
            }
        }
    },
    {
        "name": "Gail Rowe Sr.",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": true,
        "id": 16,
        "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": "Qui dolorum dicta expedita itaque sed rerum consectetur."
            },
            "description": {
                "en": "Qui qui at sint nihil. Aut laboriosam expedita nostrum assumenda. Molestias tempora at illum rerum molestias earum."
            },
            "url": {
                "en": "http://bogisich.info/id-voluptatibus-qui-ut-qui-adipisci-quaerat.html"
            }
        }
    },
    {
        "name": "Robin Schmidt Jr.",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": false,
        "id": 11,
        "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": "Accusantium deserunt temporibus nemo fugiat velit."
            },
            "description": {
                "en": "Et consequatur unde quisquam provident distinctio quia. Quas et consequuntur dicta labore molestiae qui omnis. Provident quisquam possimus porro numquam aut sit illo."
            },
            "url": {
                "en": "https://runolfsson.com/harum-natus-quis-inventore-nisi-laborum-non.html"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.4.0 stable