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

[
    {
        "name": "Norene Ledner MD",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": false,
        "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": "Voluptatem nihil tenetur est et adipisci ea sint cumque non consequatur vitae."
            },
            "description": {
                "en": "Asperiores iure aspernatur veniam laudantium enim enim. Ut atque sint dolorum amet. Iusto et dicta et recusandae."
            },
            "url": {
                "en": "http://www.corkery.org/voluptas-omnis-nesciunt-expedita-aut"
            }
        }
    },
    {
        "name": "Emelia Gleichner",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "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": true
        },
        "seo": {
            "title": {
                "en": "Quia nisi labore voluptas voluptatem ducimus atque ut."
            },
            "description": {
                "en": "Laborum tenetur voluptas architecto tenetur enim voluptatem modi. Placeat eum ea impedit voluptatem. In consectetur tenetur consequatur consequatur ut."
            },
            "url": {
                "en": "http://www.anderson.com/"
            }
        }
    },
    {
        "name": "Jensen Lynch",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "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": false
        },
        "seo": {
            "title": {
                "en": "Eos numquam autem ex dolores asperiores minima."
            },
            "description": {
                "en": "Voluptates neque quis assumenda quis. Sint dolorem blanditiis delectus saepe. Et possimus perspiciatis non et quasi debitis. Eos enim omnis ut nisi itaque voluptas non. Veritatis et et vel sed iure."
            },
            "url": {
                "en": "http://www.balistreri.com/omnis-consequatur-et-qui-est-aut-et-quod-in"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.0.1 stable