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

[
    {
        "name": "Christopher Gislason",
        "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": "Numquam cum est qui non deleniti in eum."
            },
            "description": {
                "en": "Quos perspiciatis provident quo totam unde nesciunt deserunt molestiae. Magni ipsa earum eaque itaque eum vel unde."
            },
            "url": {
                "en": "http://www.rodriguez.org/nihil-sit-alias-nulla-consequatur-reprehenderit-maxime.html"
            }
        }
    },
    {
        "name": "Adrien Hermiston",
        "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": false
        },
        "seo": {
            "title": {
                "en": "Ratione sed sint aut tenetur est id numquam est aspernatur."
            },
            "description": {
                "en": "Vero ut assumenda dolores quos ea earum quas. Quia ipsam eum tempora ut nihil. Iste voluptatem nam aliquid qui recusandae ratione."
            },
            "url": {
                "en": "https://mante.biz/laborum-suscipit-perferendis-mollitia-voluptas-est-vero.html"
            }
        }
    },
    {
        "name": "Mckenna Hahn III",
        "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": "Veritatis ut aliquid maxime qui eos earum qui id officiis recusandae."
            },
            "description": {
                "en": "Rerum tempore atque et itaque eius. Nemo velit eveniet quo ullam vel repudiandae. Excepturi ducimus quia harum placeat harum ipsum modi. Saepe sequi sapiente eum voluptas facere."
            },
            "url": {
                "en": "http://sipes.net/sapiente-molestiae-voluptas-atque.html"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.5.2 stable