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/11/categories HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.6.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: 3795

[
    {
        "name": "Milton Ruecker Sr.",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": true,
        "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": "Excepturi ut officiis quia autem odit ullam."
            },
            "description": {
                "en": "Adipisci quaerat omnis assumenda atque explicabo. Repudiandae facilis nemo amet consequuntur est. Quasi similique architecto fugiat."
            },
            "url": {
                "en": "http://www.orn.com/"
            }
        }
    },
    {
        "name": "Loraine Shields",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": false,
        "id": 18,
        "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": "Ad sint omnis nisi dignissimos laboriosam."
            },
            "description": {
                "en": "Odio sequi eius optio doloribus enim fuga. Ullam ut laudantium velit ullam. Voluptatem nihil reprehenderit aut quas et voluptatem dolorem."
            },
            "url": {
                "en": "http://www.murphy.org/voluptatem-repellendus-minus-accusantium"
            }
        }
    },
    {
        "name": "Kevin Kunde",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "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": "Dolorem est nostrum tempora sed est."
            },
            "description": {
                "en": "Sunt ex mollitia eligendi soluta voluptatem aut. Et aut quod labore dolorum deleniti facere accusamus eum. Non rerum quis et fuga pariatur."
            },
            "url": {
                "en": "http://gutmann.org/id-nulla-dignissimos-dolore-possimus-accusamus-accusamus.html"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.6.0 stable