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

[
    {
        "name": "Dr. Myron Mueller II",
        "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": "Et expedita sequi magnam minima praesentium."
            },
            "description": {
                "en": "Et eaque aut ut possimus repellat esse. Ut impedit aut repellat reprehenderit et ut officiis. Ea porro nulla aut molestiae ea provident. Quis maiores deleniti rem velit."
            },
            "url": {
                "en": "http://kuhn.com/"
            }
        }
    },
    {
        "name": "Verner Kerluke II",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": false,
        "id": 18,
        "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": "Debitis aut veniam provident laboriosam id."
            },
            "description": {
                "en": "Soluta consequatur debitis et ducimus. Recusandae sit dolor amet dolores. Et eligendi omnis facilis quibusdam temporibus. Rerum sint maxime nemo."
            },
            "url": {
                "en": "https://www.bartoletti.com/vero-veniam-nihil-facilis"
            }
        }
    },
    {
        "name": "Prof. Joel Botsford Jr.",
        "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": true
        },
        "seo": {
            "title": {
                "en": "Temporibus quo quas accusantium rem debitis ut eveniet alias."
            },
            "description": {
                "en": "Ut aut quis tenetur quas et numquam. Temporibus et assumenda aut ut saepe modi. Ut consectetur consequatur inventore occaecati quia. Id placeat fugiat et officia voluptatem."
            },
            "url": {
                "en": "http://www.reichel.org/maiores-labore-facilis-illum-architecto"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.2.0 stable