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/15/categories HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.0.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: 4057

[
    {
        "name": "Albin Wintheiser",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": false,
        "id": 18,
        "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": "Repudiandae commodi voluptas non et beatae nihil quia dolorum quasi consequatur."
            },
            "description": {
                "en": "Qui ratione facilis et rerum facere nulla nisi eos. Odit reiciendis neque sed voluptatem et aut. Quos porro et numquam. Eius dolorem aliquam alias architecto quis occaecati est."
            },
            "url": {
                "en": "http://www.rodriguez.com/praesentium-voluptatum-architecto-cum-perspiciatis-maiores"
            }
        }
    },
    {
        "name": "General Renner",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": false,
        "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": false
        },
        "seo": {
            "title": {
                "en": "Nulla asperiores et quia earum laborum aut voluptatem aut autem omnis."
            },
            "description": {
                "en": "Reprehenderit quo incidunt minus quas sed est quaerat. Natus adipisci voluptas et in vitae tenetur. Quia rem officiis quo ad. Aut aut voluptatem id explicabo in saepe nisi."
            },
            "url": {
                "en": "http://weimann.com/doloribus-ut-rem-repudiandae-sed-necessitatibus-consequatur-maxime"
            }
        }
    },
    {
        "name": "Queenie Watsica",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": true,
        "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": "Omnis iusto et atque quia iste fugit quasi quo minima."
            },
            "description": {
                "en": "Et asperiores esse ea quidem voluptate praesentium corrupti velit. Nam fuga vel est libero expedita. Sit facere ipsa sapiente sit accusamus. Corporis id deleniti eligendi enim."
            },
            "url": {
                "en": "http://price.com/blanditiis-qui-illum-ea-quaerat-totam-in"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.0.0 stable