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.8.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
code String? Nullable. A custom code. You can set this to your own code and use this field to map your categories to Bakeronline categories
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: 3930

[
    {
        "name": "Dakota Muller",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": true,
        "code": "...",
        "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": {
                "en": "Et quo earum sit eos officiis."
            },
            "description": {
                "en": "Illo minima tempora sequi corrupti. Molestiae recusandae occaecati ea consequuntur et. Accusamus minima ducimus voluptatem rerum enim. Quis tempora molestiae voluptate sint."
            },
            "url": {
                "en": "http://www.bauch.com/"
            }
        }
    },
    {
        "name": "Prof. Modesto Strosin DDS",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": false,
        "code": "...",
        "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": true
        },
        "seo": {
            "title": {
                "en": "Quisquam aut deserunt sequi earum ut similique qui occaecati dolorum aut ea."
            },
            "description": {
                "en": "Eum sint perferendis et fugiat repudiandae. Eius laboriosam et ipsam velit minima sed et. Odio et vel similique eos. Cupiditate est autem tenetur quos ducimus praesentium veritatis."
            },
            "url": {
                "en": "http://www.kuhlman.com/"
            }
        }
    },
    {
        "name": "Miss Viola Considine DVM",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": true,
        "code": "...",
        "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": true
        },
        "seo": {
            "title": {
                "en": "Quo error laborum enim enim nobis quia minus ea corrupti."
            },
            "description": {
                "en": "Labore odit iste et impedit. Id eum porro adipisci est quo consequatur sit. Quisquam et ut sequi labore. Quo tempora dolores iure eum."
            },
            "url": {
                "en": "http://anderson.org/quia-ut-recusandae-qui.html"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.8.0 stable