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/19/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: 3970

[
    {
        "name": "Jaylen Parisian",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": false,
        "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": "Possimus reprehenderit similique culpa porro sint voluptates amet voluptatibus voluptas."
            },
            "description": {
                "en": "Et ea labore rerum aspernatur provident doloribus. Sit qui cupiditate et minima laboriosam molestias. Dicta voluptate quia ullam qui esse libero."
            },
            "url": {
                "en": "http://wisozk.biz/ducimus-in-quibusdam-eum-et-magnam"
            }
        }
    },
    {
        "name": "Miss Clotilde Upton",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": false,
        "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": true
        },
        "seo": {
            "title": {
                "en": "Reiciendis laboriosam facilis eos necessitatibus quas saepe."
            },
            "description": {
                "en": "Molestias eum corrupti vel sapiente quibusdam iure. Unde ut qui aperiam inventore debitis voluptatibus. Qui quam blanditiis voluptas omnis molestias. Iusto ipsam praesentium consequatur sed."
            },
            "url": {
                "en": "https://www.blick.org/consequuntur-eius-aut-voluptatem-ducimus-earum"
            }
        }
    },
    {
        "name": "Lourdes Schinner",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": true,
        "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": "Esse aut harum modi nulla dolorum ut alias aut nemo excepturi."
            },
            "description": {
                "en": "Rem possimus nihil voluptatibus fuga aperiam saepe veniam enim. Praesentium quis id rem vel tempore culpa sequi non. Tempora similique in velit ad atque possimus hic eveniet."
            },
            "url": {
                "en": "http://www.emmerich.com/"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.4.0 stable