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

[
    {
        "name": "Dr. Sophie Lemke PhD",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "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": false
        },
        "seo": {
            "title": {
                "en": "Facere pariatur repellat molestiae nobis rem quia deserunt."
            },
            "description": {
                "en": "Consequatur voluptatem blanditiis molestiae tenetur similique. Iste laboriosam iure enim eum et minus architecto sunt. Et dolorum iusto voluptatem quis nulla accusamus dolor odio."
            },
            "url": {
                "en": "http://ward.com/"
            }
        }
    },
    {
        "name": "Hildegard McDermott",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": true,
        "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": "Temporibus sequi possimus laboriosam voluptas incidunt eum."
            },
            "description": {
                "en": "Sint ab voluptatem dolorem quae aut. Deserunt sapiente qui vero."
            },
            "url": {
                "en": "http://wiegand.com/accusantium-perspiciatis-repellendus-sequi.html"
            }
        }
    },
    {
        "name": "Tyrese Funk I",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "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": false
        },
        "seo": {
            "title": {
                "en": "Temporibus et aspernatur rem aperiam sint praesentium in sunt."
            },
            "description": {
                "en": "Quis voluptatem quod totam molestias. Iste rerum assumenda omnis architecto recusandae voluptatem. Porro id accusantium accusantium aut. Officiis molestiae et et modi quia labore autem."
            },
            "url": {
                "en": "http://pagac.com/dolor-rerum-laborum-modi"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.7.0 stable