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/13/categories HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.3.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: 3952

[
    {
        "name": "Mr. Trenton Witting",
        "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": {
                "en": "Quis consequatur necessitatibus corrupti corporis sint repellendus est sit."
            },
            "description": {
                "en": "Rerum tenetur qui sed facilis. Eligendi ut possimus dignissimos voluptatem amet accusamus labore. Qui ut consequatur ut quia quod. Sit suscipit totam molestiae dolor delectus rerum ducimus quis."
            },
            "url": {
                "en": "http://www.rosenbaum.com/"
            }
        }
    },
    {
        "name": "Skyla Kerluke Jr.",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": false,
        "id": 17,
        "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": "Dolorem ea voluptas ea quos sunt praesentium."
            },
            "description": {
                "en": "Doloribus earum distinctio occaecati corporis fuga rerum. Ducimus id corrupti eum qui. Et quod ea a. Sit incidunt iusto placeat dolore autem."
            },
            "url": {
                "en": "http://mccullough.org/quia-ipsa-suscipit-molestiae-accusantium-accusantium-voluptatem-delectus.html"
            }
        }
    },
    {
        "name": "Eudora Metz PhD",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": true,
        "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": false
        },
        "seo": {
            "title": {
                "en": "Error in neque expedita cupiditate quis voluptatem."
            },
            "description": {
                "en": "Tempora sed veritatis officia voluptatem consequuntur. Rerum sint ipsa maiores maxime qui recusandae cupiditate. Aut natus et laudantium et corporis."
            },
            "url": {
                "en": "http://miller.com/omnis-ut-voluptatem-consequatur-est-voluptate"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.3.0 stable