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/18/categories HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 0.3.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: 3989

[
    {
        "name": "Rosina Williamson",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": false,
        "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": true
        },
        "seo": {
            "title": {
                "en": "Tenetur incidunt veritatis quia non delectus explicabo voluptas accusamus."
            },
            "description": {
                "en": "Vel excepturi perspiciatis error sed consectetur explicabo. Voluptates ut eum et sequi dolorem doloribus quae. Impedit placeat eos et facilis ut sed nulla dolores."
            },
            "url": {
                "en": "http://www.friesen.com/occaecati-repellendus-eaque-autem-repudiandae-aut"
            }
        }
    },
    {
        "name": "Nova Welch",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "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": true
        },
        "seo": {
            "title": {
                "en": "Consequatur est dicta accusamus omnis suscipit veritatis aliquam qui consequatur culpa unde."
            },
            "description": {
                "en": "Harum facilis placeat iste magnam nemo et ut odio. Est nulla eum quos iusto modi. Et et harum totam rerum. Vel quidem voluptas qui rem non molestiae."
            },
            "url": {
                "en": "http://moen.com/voluptates-voluptas-quod-ipsam-aliquid-sit-pariatur-neque.html"
            }
        }
    },
    {
        "name": "Mr. Akeem Mueller",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": false,
        "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": "Enim aut excepturi libero omnis beatae culpa adipisci cum possimus."
            },
            "description": {
                "en": "Repellendus a et optio ratione at nesciunt debitis. Deleniti veniam a voluptatem et consequatur doloremque aut. Recusandae tenetur quia esse ut minima quia voluptatem impedit."
            },
            "url": {
                "en": "http://ernser.com/"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
0.3.0 stable