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.9.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.
overview_image 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: 5916

[
    {
        "name": "Jadyn Nicolas",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "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
                }
            ],
            "file_id": 13,
            "white_background": false
        },
        "overview_image": {
            "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
                }
            ],
            "file_id": 15,
            "white_background": false
        },
        "seo": {
            "title": {
                "en": "Rerum autem est ea necessitatibus qui aut temporibus temporibus."
            },
            "description": {
                "en": "Iure est molestiae minima ullam necessitatibus est tempora. Perferendis ut quia dicta libero veritatis amet sed. Facere iure officiis occaecati suscipit. Eum quae quaerat rerum veritatis dolorem aut."
            },
            "url": {
                "en": "http://www.maggio.biz/"
            }
        }
    },
    {
        "name": "Mr. Gonzalo Corwin DDS",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": false,
        "code": "...",
        "id": 13,
        "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
                }
            ],
            "file_id": 10,
            "white_background": true
        },
        "overview_image": {
            "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
                }
            ],
            "file_id": 18,
            "white_background": false
        },
        "seo": {
            "title": {
                "en": "Voluptatem sit voluptatum neque sed quia aut maxime accusamus."
            },
            "description": {
                "en": "Dolor explicabo dicta eos vitae ut ratione. Expedita hic nisi neque iste. Nobis earum illum id iste dolorum impedit sint occaecati. Placeat aliquam et suscipit ex dignissimos."
            },
            "url": {
                "en": "https://www.daniel.com/voluptatibus-occaecati-ipsam-modi-aut"
            }
        }
    },
    {
        "name": "Nicole Wolff",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": true,
        "code": "...",
        "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
                }
            ],
            "file_id": 15,
            "white_background": true
        },
        "overview_image": {
            "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
                }
            ],
            "file_id": 14,
            "white_background": false
        },
        "seo": {
            "title": {
                "en": "Magni molestias qui error velit blanditiis vel."
            },
            "description": {
                "en": "Qui repudiandae culpa labore molestiae accusamus quia quia. Quis sint est dolores quo earum pariatur praesentium. Voluptatem voluptates consequatur vero expedita est dolores vel."
            },
            "url": {
                "en": "http://jenkins.info/"
            }
        }
    }
]
1.9.0 stable