Get all the categories that belong to a shop

GET /company/shops/@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 shop

Example request 1

GET /company/shops/15/categories HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 0.2.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: 3874

[
    {
        "name": "Oscar Keebler PhD",
        "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": false
        },
        "seo": {
            "title": {
                "en": "Delectus dolorem non dolorem aut quis tenetur voluptate nihil est."
            },
            "description": {
                "en": "Quae in perspiciatis ipsam quod. Sit voluptas rerum impedit esse. Quaerat corrupti cupiditate consequuntur."
            },
            "url": {
                "en": "https://schimmel.com/voluptatem-illum-dolor-saepe-eveniet-minima-qui-tenetur.html"
            }
        }
    },
    {
        "name": "Mikel Quitzon",
        "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": "Corporis possimus non velit laborum nihil esse modi deserunt numquam."
            },
            "description": {
                "en": "Debitis aut tempore eum voluptate ipsa suscipit aut. Velit rerum fugit soluta expedita perspiciatis. Quibusdam exercitationem commodi praesentium laborum et provident."
            },
            "url": {
                "en": "http://www.schultz.com/"
            }
        }
    },
    {
        "name": "Dr. Modesto Rowe IV",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "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": true
        },
        "seo": {
            "title": {
                "en": "Voluptate beatae similique voluptates in exercitationem nostrum libero vel recusandae."
            },
            "description": {
                "en": "Explicabo autem ea omnis quia et. Perspiciatis nemo et voluptate. Nesciunt vero distinctio et velit natus quas excepturi."
            },
            "url": {
                "en": "http://www.russel.com/laboriosam-odit-rerum-et"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
0.2.0 stable