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/14/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: 3443

[
    {
        "name": "Angel Powlowski",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": true,
        "id": 10,
        "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": "Ut repudiandae eum explicabo non et dicta.",
            "description": "Eum eum sint possimus quos et in in. Dolor nemo omnis iusto perspiciatis delectus ea amet. Architecto ipsum modi ratione voluptate optio magnam voluptatem.",
            "url": "http://www.schmitt.com/"
        }
    },
    {
        "name": "Jaquan Hoppe",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": false,
        "id": 15,
        "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": "Impedit a vitae dignissimos tempore iste.",
            "description": "Doloremque dolore ut atque. Voluptate fugit dolor sint et sit ut quod consectetur.",
            "url": "http://kovacek.org/beatae-quidem-totam-nostrum-ratione.html"
        }
    },
    {
        "name": "Randall Jacobi",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": true,
        "id": 10,
        "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": "Non quaerat voluptas velit cumque quas sapiente adipisci.",
            "description": "Velit et quia qui animi. Suscipit est unde magnam neque officiis ducimus ullam harum. In est distinctio praesentium itaque. Sit ipsum dolorum ea a saepe.",
            "url": "http://www.beahan.biz/ipsa-beatae-maxime-placeat-omnis-corrupti-dolorem.html"
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.6.0)
1.5.0 stable