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.5.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: 4000

[
    {
        "name": "Clementine Bernhard",
        "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": false
        },
        "seo": {
            "title": {
                "en": "Saepe ipsa id cumque accusantium quia est iusto omnis voluptatem nesciunt."
            },
            "description": {
                "en": "Odit tempore debitis laudantium blanditiis ipsa omnis expedita. Quas animi modi tempora voluptatem numquam quia repellat officia. Vel non molestiae quos ratione aut dolores. Quisquam iure in enim."
            },
            "url": {
                "en": "http://www.beatty.com/fugiat-repellat-beatae-quia-eius-ut-et"
            }
        }
    },
    {
        "name": "Miss Luisa Greenholt III",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": true,
        "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": true
        },
        "seo": {
            "title": {
                "en": "Minima odit modi minima ut autem."
            },
            "description": {
                "en": "Porro distinctio vitae officia minima maxime quam velit. Quaerat sit aut sed. Doloribus distinctio sint eum sint assumenda eos voluptas et. Sequi voluptas recusandae non."
            },
            "url": {
                "en": "http://www.schumm.com/id-aliquid-aut-culpa-dolorem"
            }
        }
    },
    {
        "name": "Candelario Barrows",
        "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": true
        },
        "seo": {
            "title": {
                "en": "Sunt repellat asperiores architecto perferendis eum dolorem tempora."
            },
            "description": {
                "en": "Vitae voluptas minima omnis. Eius similique quidem ut doloribus autem veniam odio consequatur. Excepturi sunt omnis dolores voluptates incidunt enim quia."
            },
            "url": {
                "en": "http://ondricka.com/voluptas-aspernatur-voluptate-quibusdam-aut-est-eligendi"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.5.0 stable