Get information about one category

GET /company/categories/@id

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 The ID of the category you want to return

Example request 1 Retrieve category

GET /company/categories/13192 HTTP/1.1
Host: api.bakeronline.be
Authorization: Bearer cba93f29df6010265e05fa36ccb39c487f4f06fbd52355cc6a9162be8ff78ba66238b59054f703e558d5ca0c5b2e2b97d40f21791abe66b3346e9c8ca18a9c82cef7343495b8b57b67be96ab7f790644b2a365ca8dab589564edc09ad6ad52c020a1ac5e
X-VERSION: 1.5.0
Accept-Language: en-US,en;q=0.5

Response

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
products [company.Product.simple] Array of company.Product.simple
shops [company.Shop.simple] Array of company.Shop.simple
id Int ID of the category
banner Image? Nullable.
seo company.SeoData Optional. The category's webpage search engine metatags

Example response 1 Retrieve category

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 2069

{
    "id": 13192,
    "name": {
        "nl": "Brown"
    },
    "description": {
        "nl": "This is a random description"
    },
    "banner": null,
    "active": true,
    "only_order_in_store": false,
    "seo": {
        "title": [],
        "description": [],
        "url": []
    },
    "products": [],
    "shops": [
        {
            "id": 2152,
            "name": "Cut the Cake",
            "active": true,
            "address": {
                "street": "Gilsonweg",
                "nr": "32",
                "zipcode": "7130",
                "city": "Dendermonde",
                "country": "BE",
                "position": {
                    "latitude": 50.8503396,
                    "longitude": 4.3517103
                }
            },
            "avatar": {
                "resolutions": [
                    {
                        "src": "https://bakeronline.be/uploads/shop-avatars/2152/180x180/bakkerij-de-pourcq-gavere.jpg",
                        "width": 180,
                        "height": 182
                    },
                    {
                        "src": "https://bakeronline.be/uploads/shop-avatars/2152/360x360/bakkerij-de-pourcq-gavere.jpg",
                        "width": 297,
                        "height": 300
                    }
                ]
            },
            "banner": {
                "resolutions": [
                    {
                        "src": "https://bakeronline.be/uploads/banner/2152/1300x315/bakkerij-aernoudt-zwijnaarde.jpg",
                        "width": 450,
                        "height": 337
                    },
                    {
                        "src": "https://bakeronline.be/uploads/banner/2152/900x250/bakkerij-aernoudt-zwijnaarde.jpg",
                        "width": 450,
                        "height": 337
                    }
                ]
            },
            "allow_comments": true,
            "allow_orders": true,
            "delivery_use_intervals": false
        }
    ]
}
1.5.0 stable