Get all the categories that belong to a company

GET /company/companies/@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 company

Example request 1

GET /company/companies/17/categories HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.5.2
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": "Mr. Avery Parker Sr.",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": false,
        "id": 13,
        "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": "Quae impedit repellendus quis hic et ea libero aut molestias esse delectus."
            },
            "description": {
                "en": "Voluptatem esse explicabo quia consequatur provident quo placeat. Aperiam explicabo quis quo illum. Laudantium sed neque laboriosam harum."
            },
            "url": {
                "en": "https://www.hackett.com/autem-explicabo-omnis-sint-id-minima-accusamus-voluptas"
            }
        }
    },
    {
        "name": "Alana Nikolaus MD",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": false,
        "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": "Aspernatur quia est voluptas perspiciatis maxime."
            },
            "description": {
                "en": "Necessitatibus aut suscipit at fugiat qui corrupti. Magni aut qui amet aut sunt est molestias. Id et itaque debitis et qui delectus."
            },
            "url": {
                "en": "https://www.harris.com/deserunt-omnis-ab-dolore"
            }
        }
    },
    {
        "name": "Enola Emmerich",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": false,
        "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": {
                "en": "Rerum possimus alias enim quam amet molestiae."
            },
            "description": {
                "en": "Iusto asperiores molestiae blanditiis ipsa eum facilis possimus. Blanditiis quis recusandae ut ullam ut. Aut autem incidunt quos non."
            },
            "url": {
                "en": "https://www.hammes.com/omnis-sequi-quia-sequi-aperiam"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.5.2 stable