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/18/categories HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.5.1
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: 3846

[
    {
        "name": "Milan Larson",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": false,
        "id": 11,
        "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": "Doloribus eligendi enim cupiditate exercitationem et."
            },
            "description": {
                "en": "Vel velit voluptas assumenda dolores quae. Aut incidunt ut quidem exercitationem. Numquam est quidem et at enim nobis voluptas."
            },
            "url": {
                "en": "http://champlin.com/ducimus-et-odit-repudiandae-voluptate-dolor"
            }
        }
    },
    {
        "name": "Freeman Balistreri",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": false,
        "id": 16,
        "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": "Dolor quibusdam consectetur et corrupti minus ab ut."
            },
            "description": {
                "en": "Consequatur sit ut reprehenderit sint delectus. Ut vitae culpa quis. Tempore et beatae ut aut. Autem libero deleniti sequi nemo ut."
            },
            "url": {
                "en": "http://www.adams.com/ea-non-fugiat-voluptatem-fugiat-impedit"
            }
        }
    },
    {
        "name": "Garrison Terry",
        "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": false
        },
        "seo": {
            "title": {
                "en": "Est inventore pariatur placeat earum sapiente ducimus."
            },
            "description": {
                "en": "Voluptatum in in et est perspiciatis dicta facilis. Vitae dolor id eum officia ipsum. Molestiae enim odio esse suscipit sed dolore. Ab et corrupti sint et deleniti autem consequuntur."
            },
            "url": {
                "en": "http://medhurst.com/"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.5.1 stable