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

GET /company/categories/15 HTTP/1.1
Host: api.bakeronline.be
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

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

{
    "name": "Stacey Oberbrunner",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": true,
    "only_order_in_store": false,
    "products": [
        {
            "name": "Dr. Kara Ankunding III",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "specialty": true,
            "active": true,
            "only_order_in_store": true,
            "price_type": "PER_UNIT",
            "price": 10,
            "target_price": false,
            "url_type": "none",
            "url": "https://example.com",
            "min_max": {
                "amount": {
                    "minimum": 19,
                    "maximum": 13,
                    "maximum_day": 11,
                    "maximum_week": 10
                },
                "weight": {
                    "minimum": 13,
                    "maximum": 16,
                    "maximum_day": 14,
                    "maximum_week": 10,
                    "suggested": 13
                },
                "persons": {
                    "minimum": 12,
                    "maximum": 16
                }
            },
            "id": 14,
            "allergens": [
                {
                    "id": 11,
                    "name": "1319"
                },
                {
                    "id": 14,
                    "name": "1322"
                },
                {
                    "id": 10,
                    "name": "1324"
                }
            ],
            "category_id": 16,
            "price_look_up_code": "...",
            "code": "...",
            "seo": {
                "title": "Repudiandae nulla aliquam ab fugit magnam.",
                "description": "Qui hic sed et consectetur fuga reprehenderit dolores. Nihil quasi magnam laborum incidunt qui dolore aspernatur quod. Ut sed explicabo et sunt quaerat inventore.",
                "url": "http://www.wolf.com/"
            }
        },
        {
            "name": "Brooklyn Rogahn",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "specialty": true,
            "active": true,
            "only_order_in_store": true,
            "price_type": "PER_UNIT",
            "price": 13,
            "target_price": true,
            "url_type": "none",
            "url": "https://example.com",
            "min_max": {
                "amount": {
                    "minimum": 13,
                    "maximum": 13,
                    "maximum_day": 10,
                    "maximum_week": 14
                },
                "weight": {
                    "minimum": 15,
                    "maximum": 18,
                    "maximum_day": 13,
                    "maximum_week": 14,
                    "suggested": 13
                },
                "persons": {
                    "minimum": 13,
                    "maximum": 18
                }
            },
            "id": 16,
            "allergens": [
                {
                    "id": 10,
                    "name": "1325"
                },
                {
                    "id": 10,
                    "name": "1329"
                },
                {
                    "id": 12,
                    "name": "1326"
                }
            ],
            "category_id": 18,
            "price_look_up_code": "...",
            "code": "...",
            "seo": {
                "title": "Error vel omnis molestias temporibus dolorem enim quaerat maxime illo excepturi.",
                "description": "Corporis et explicabo ipsum rem vero. Possimus corporis recusandae sunt. Doloribus placeat libero laborum enim neque nam. Dolorem est temporibus placeat necessitatibus.",
                "url": "https://beer.com/eos-enim-reiciendis-molestias-animi-modi-dolores-magnam.html"
            }
        },
        {
            "name": "Ashleigh Nader",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "specialty": false,
            "active": false,
            "only_order_in_store": false,
            "price_type": "PER_UNIT",
            "price": 15,
            "target_price": false,
            "url_type": "none",
            "url": "https://example.com",
            "min_max": {
                "amount": {
                    "minimum": 12,
                    "maximum": 11,
                    "maximum_day": 13,
                    "maximum_week": 12
                },
                "weight": {
                    "minimum": 14,
                    "maximum": 11,
                    "maximum_day": 19,
                    "maximum_week": 16,
                    "suggested": 16
                },
                "persons": {
                    "minimum": 15,
                    "maximum": 12
                }
            },
            "id": 11,
            "allergens": [
                {
                    "id": 11,
                    "name": "1331"
                },
                {
                    "id": 15,
                    "name": "1325"
                },
                {
                    "id": 17,
                    "name": "1326"
                }
            ],
            "category_id": 15,
            "price_look_up_code": "...",
            "code": "...",
            "seo": {
                "title": "Aperiam nulla quos aperiam magni dolor beatae dolorem odio optio.",
                "description": "Tenetur ut consequuntur ea quo nihil. Consequatur quis nam enim similique tempora aspernatur a nesciunt. Doloribus ut quo et ut explicabo tenetur quod. Quia dolore iusto voluptas fuga et.",
                "url": "https://www.rolfson.info/eveniet-itaque-illo-aut-a"
            }
        }
    ],
    "shops": [
        {
            "name": "Lila Franecki",
            "active": false,
            "address": {
                "street": "Sint-Denijslaan",
                "nr": "96",
                "zipcode": "9000",
                "city": "Gent",
                "country": "BE",
                "position": {
                    "latitude": 1.54361,
                    "longitude": 0.45645
                }
            },
            "allow_comments": false,
            "allow_orders": true,
            "delivery_use_intervals": true,
            "id": 16,
            "avatar": {
                "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
            },
            "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
            }
        },
        {
            "name": "Fritz Crooks",
            "active": true,
            "address": {
                "street": "Sint-Denijslaan",
                "nr": "96",
                "zipcode": "9000",
                "city": "Gent",
                "country": "BE",
                "position": {
                    "latitude": 1.54361,
                    "longitude": 0.45645
                }
            },
            "allow_comments": true,
            "allow_orders": true,
            "delivery_use_intervals": false,
            "id": 10,
            "avatar": {
                "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
            },
            "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
            }
        },
        {
            "name": "Lottie Auer",
            "active": true,
            "address": {
                "street": "Sint-Denijslaan",
                "nr": "96",
                "zipcode": "9000",
                "city": "Gent",
                "country": "BE",
                "position": {
                    "latitude": 1.54361,
                    "longitude": 0.45645
                }
            },
            "allow_comments": true,
            "allow_orders": true,
            "delivery_use_intervals": false,
            "id": 17,
            "avatar": {
                "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
            },
            "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
            }
        }
    ],
    "id": 15,
    "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": "Fugiat sit odit est et eum aspernatur architecto necessitatibus.",
        "description": "Eius maxime voluptas et ducimus nam veniam. Unde culpa ab unde autem quis debitis aut. Vero et atque consequuntur dolore deserunt porro nobis.",
        "url": "http://okon.com/natus-eius-aperiam-velit-enim-perspiciatis-omnis-vero"
    }
}
Version update available Please adjust your integration to the latest stable version (1.6.0)
1.5.0 stable