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

[
    {
        "name": "Salma Armstrong",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": false,
        "id": 12,
        "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": "Ut ipsa earum beatae non quia."
            },
            "description": {
                "en": "Omnis voluptate quasi eos. Doloribus nobis sunt molestiae. Recusandae nulla delectus quo voluptatibus eaque. Possimus eveniet nesciunt ut omnis voluptatem exercitationem fuga aliquam."
            },
            "url": {
                "en": "http://www.okon.com/ut-delectus-voluptates-sint-rem-ut-suscipit.html"
            }
        }
    },
    {
        "name": "Prof. Tracy Purdy PhD",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": false,
        "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": false
        },
        "seo": {
            "title": {
                "en": "Adipisci quas voluptatem dolores iste provident porro assumenda voluptate excepturi distinctio."
            },
            "description": {
                "en": "Velit reiciendis quod recusandae hic repudiandae vel et. Quo est aliquam quibusdam neque voluptatum."
            },
            "url": {
                "en": "http://murazik.com/ex-vel-veritatis-quia-unde-eum-eum-voluptatibus.html"
            }
        }
    },
    {
        "name": "Durward Botsford",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "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": true
        },
        "seo": {
            "title": {
                "en": "Debitis natus aspernatur totam exercitationem facere rerum numquam."
            },
            "description": {
                "en": "Et et voluptate soluta neque ut repellendus. Quis assumenda eum adipisci sed. Magnam nam error nisi porro velit soluta."
            },
            "url": {
                "en": "https://www.lind.com/iusto-impedit-ea-aut-quam-necessitatibus"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.1.0 stable