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: 1.0.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: 3881

[
    {
        "name": "Yessenia Von",
        "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": true
        },
        "seo": {
            "title": {
                "en": "Modi est voluptas error quidem architecto."
            },
            "description": {
                "en": "Hic culpa laudantium aut earum. Praesentium rerum eligendi repellendus. Officiis numquam omnis quis repudiandae unde. Quas quae aliquam id sapiente ut. Expedita nemo maiores molestiae harum magnam."
            },
            "url": {
                "en": "https://www.maggio.org/error-quos-et-sed-at"
            }
        }
    },
    {
        "name": "Dr. Kiel Hagenes MD",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": true,
        "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": "Facilis iste distinctio nihil iste aut est enim."
            },
            "description": {
                "en": "Natus recusandae placeat rerum modi. Autem harum tempore distinctio necessitatibus nisi asperiores qui. Magni non dolorem aliquid est molestiae."
            },
            "url": {
                "en": "http://greenholt.com/aliquid-velit-quis-velit-odit.html"
            }
        }
    },
    {
        "name": "Adela Carter",
        "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": "Sed culpa eum voluptatem dolor doloremque accusantium accusamus atque voluptates ut."
            },
            "description": {
                "en": "Ea ad quis libero molestiae. Ut mollitia nihil in quia maxime eligendi. Necessitatibus expedita alias aut ipsam ullam a quae."
            },
            "url": {
                "en": "http://www.rutherford.com/ad-qui-esse-et-aut"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.0.0 stable