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: 0.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: 3972

[
    {
        "name": "Vicenta Douglas",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": true,
        "id": 16,
        "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": "Fuga sunt facilis autem explicabo error non suscipit eos illum."
            },
            "description": {
                "en": "Aut nulla quo eos adipisci adipisci. A error qui et temporibus. Facere perspiciatis laudantium corrupti."
            },
            "url": {
                "en": "https://www.cartwright.org/et-sequi-sit-fuga-id-saepe-adipisci"
            }
        }
    },
    {
        "name": "Dr. Dannie Lang",
        "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": "Dicta accusantium cum recusandae sint numquam suscipit."
            },
            "description": {
                "en": "Maxime ducimus dolorem iste ipsa unde sit. Voluptas quidem omnis fugiat voluptatem. Consequuntur autem quam commodi consequuntur quaerat est sapiente officiis. Et id odit a quis aspernatur qui."
            },
            "url": {
                "en": "http://thiel.com/ut-quisquam-ut-consequatur-saepe-recusandae-eum.html"
            }
        }
    },
    {
        "name": "Amaya Kunze",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": true,
        "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
                }
            ],
            "white_background": true
        },
        "seo": {
            "title": {
                "en": "Dolores soluta ullam velit veritatis harum fugit corporis provident hic."
            },
            "description": {
                "en": "Qui illum voluptatem exercitationem consequatur. Sit nam porro vel dolorum. Ullam aut repudiandae rem aliquam ut a. Rerum dolore optio voluptas et doloremque vel blanditiis numquam."
            },
            "url": {
                "en": "http://www.marvin.com/doloremque-consequatur-quis-ut-adipisci-vero-modi.html"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
0.3.0 stable