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/16/categories HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 0.2.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: 3751

[
    {
        "name": "Domenica O'Hara",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "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": true
        },
        "seo": {
            "title": {
                "en": "Porro id dignissimos magnam unde blanditiis dolores facilis."
            },
            "description": {
                "en": "Id ex autem quis ipsum inventore minus. Et unde eum eius et aut unde."
            },
            "url": {
                "en": "http://www.okon.com/quasi-est-sit-aliquam-in-repellendus-est.html"
            }
        }
    },
    {
        "name": "Prof. Lafayette Boyer",
        "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": true
        },
        "seo": {
            "title": {
                "en": "Molestiae quasi beatae nihil recusandae quo ut soluta sed dolore veritatis."
            },
            "description": {
                "en": "Facilis sed eos ipsam modi. Rem odio ab odit. Eum et earum quis aspernatur dolor illum perspiciatis."
            },
            "url": {
                "en": "http://www.haag.biz/"
            }
        }
    },
    {
        "name": "Jannie Gaylord Sr.",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "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": false
        },
        "seo": {
            "title": {
                "en": "Iure qui reiciendis qui animi hic commodi aut."
            },
            "description": {
                "en": "Eveniet unde et ex beatae nesciunt. Ab repudiandae dignissimos ipsa sit libero dicta est. Recusandae voluptatem eveniet qui omnis quia repellendus ea aliquid."
            },
            "url": {
                "en": "http://www.okuneva.com/esse-non-officiis-omnis"
            }
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.9.0)
0.2.2 stable