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/12/categories HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.6.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: 3829

[
    {
        "name": "Stewart Yost V",
        "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": {
                "en": "Officiis omnis voluptatem accusantium aut error."
            },
            "description": {
                "en": "Aperiam quia error modi ducimus quod architecto ipsum. Ad facere fuga dolorem blanditiis quo in. Ea rerum dolorum est repellat."
            },
            "url": {
                "en": "http://www.crooks.net/"
            }
        }
    },
    {
        "name": "Hadley Hegmann",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "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": "Nobis impedit nemo et laborum reiciendis quisquam consequatur."
            },
            "description": {
                "en": "Quibusdam laboriosam eos recusandae minima non expedita. Eius eveniet veniam sed similique reprehenderit ducimus et. Totam nisi deserunt aliquid voluptate."
            },
            "url": {
                "en": "http://kozey.com/quidem-aspernatur-aspernatur-aut-voluptatem"
            }
        }
    },
    {
        "name": "Albertha Jacobs",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "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": false
        },
        "seo": {
            "title": {
                "en": "Voluptate voluptatem consequatur dolorem autem ea blanditiis iste quasi."
            },
            "description": {
                "en": "Asperiores qui iusto aut repellat sit ut. Expedita veniam dolor magni mollitia. Quis consequatur aliquid nisi et. Deleniti quas quam facere iusto sit voluptatem."
            },
            "url": {
                "en": "http://hartmann.com/"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.6.0 stable