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.7.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: 4004

[
    {
        "name": "William Schroeder",
        "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": "Omnis explicabo corporis debitis blanditiis beatae voluptates."
            },
            "description": {
                "en": "Ducimus sunt non quas nemo. Pariatur atque culpa ipsam eaque nesciunt ab ipsa et. Nulla dignissimos dolorum iste quia quibusdam aliquam et."
            },
            "url": {
                "en": "http://oconner.com/et-aut-hic-minima-velit-et-quo-nobis.html"
            }
        }
    },
    {
        "name": "Dr. Kariane Bosco",
        "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": false
        },
        "seo": {
            "title": {
                "en": "Ipsa iusto quod unde alias est soluta modi minima architecto aliquid."
            },
            "description": {
                "en": "Enim ad iusto in distinctio minus sit. Quas doloremque unde sit. Asperiores vel et ut architecto pariatur et. In fugiat velit est hic. Omnis incidunt maxime velit quas. Tempora qui provident est."
            },
            "url": {
                "en": "http://feil.com/voluptas-quas-maxime-tempora-sed-est-harum-velit"
            }
        }
    },
    {
        "name": "Garth Heidenreich DVM",
        "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": "Distinctio sunt dolore reiciendis dolor ducimus sequi aut aut."
            },
            "description": {
                "en": "Perspiciatis doloremque autem ratione est iure. At et quasi perspiciatis rerum labore. Ex sit maiores laborum et animi sit libero. Quasi placeat et omnis iure quam est dolores temporibus."
            },
            "url": {
                "en": "https://turner.org/sed-dolores-ut-ratione-commodi.html"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.7.0 stable