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.5.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: 3887

[
    {
        "name": "Dr. Robb Jacobs",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": false,
        "id": 12,
        "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": "Sed omnis fugit nobis impedit molestias temporibus voluptas cupiditate eaque saepe."
            },
            "description": {
                "en": "Cumque eligendi odit delectus. Deserunt sit dolores nobis nostrum qui ab aut. Quia et temporibus eum quia totam. Et quibusdam quibusdam et ullam architecto pariatur tempora."
            },
            "url": {
                "en": "http://bechtelar.com/illo-voluptatem-ad-quia-et-earum-quasi"
            }
        }
    },
    {
        "name": "Myrl Yundt",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "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": "Id aut perferendis saepe incidunt veniam omnis voluptates rerum aut quam."
            },
            "description": {
                "en": "Officiis sunt eius ut architecto. Quo tempora autem vel reprehenderit consequatur. Sit ab iure non."
            },
            "url": {
                "en": "http://romaguera.biz/"
            }
        }
    },
    {
        "name": "Albin Monahan",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": false,
        "id": 12,
        "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": "Nemo et voluptas sunt exercitationem deleniti nam."
            },
            "description": {
                "en": "Quis dolorum occaecati sit ipsa eum voluptatem minima. Sunt molestiae nobis quisquam eveniet et harum vel. Esse fuga ducimus in impedit minus earum. Et necessitatibus sit aut itaque."
            },
            "url": {
                "en": "http://www.roob.org/ea-neque-ut-possimus-velit-qui"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.5.0 stable