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/3870 HTTP/1.1
Host: api.bakeronline.be
Authorization: Bearer 9897a4780cfae52a242252f573e66bc56167be7c5f835ba58da084a6073875ee28733b5316478ac28958bfec2545ad359efb1bfce5b10fe71cdb8b05b7f7bdb61b622aa3b226d191c65c1a7c183aaa6bc63d8bfedef3984796e3021fe6b20c6dc501bab9
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: 2117

{
    "id": 3870,
    "name": {
        "nl": "BurlyWood"
    },
    "description": {
        "nl": "This is a random description"
    },
    "banner": null,
    "active": true,
    "only_order_in_store": false,
    "seo": {
        "title": [],
        "description": [],
        "url": []
    },
    "products": [],
    "shops": [
        {
            "id": 2928,
            "name": "Best Thing Since Sliced Bread",
            "active": true,
            "address": {
                "street": "Ponceletsteeg",
                "nr": "13",
                "zipcode": "7331",
                "city": "Mechelen",
                "country": "BE",
                "position": {
                    "latitude": 51.260197,
                    "longitude": 4.402771
                }
            },
            "avatar": {
                "resolutions": [
                    {
                        "src": "https://bakeronline.be/uploads/shop-avatars/2928/180x180/slagerij-van-de-velde-van-tomme-bestel-en-haal-af.jpg",
                        "width": 180,
                        "height": 180
                    },
                    {
                        "src": "https://bakeronline.be/uploads/shop-avatars/2928/360x360/slagerij-van-de-velde-van-tomme-bestel-en-haal-af.jpg",
                        "width": 300,
                        "height": 300
                    }
                ]
            },
            "banner": {
                "resolutions": [
                    {
                        "src": "https://bakeronline.be/uploads/banner/2928/1300x315/bakkerij-serbruyns.jpg",
                        "width": 300,
                        "height": 300
                    },
                    {
                        "src": "https://bakeronline.be/uploads/banner/2928/900x250/bakkerij-serbruyns.jpg",
                        "width": 300,
                        "height": 300
                    }
                ]
            },
            "allow_comments": false,
            "allow_orders": true,
            "delivery_use_intervals": false
        }
    ]
}
Version update available Please adjust your integration to the latest stable version (1.5.2)
1.5.0 stable