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/17 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.8.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
code String? Nullable. A custom code. You can set this to your own code and use this field to map your categories to Bakeronline categories
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: 14299

{
    "name": "Lillian Weber",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": true,
    "only_order_in_store": false,
    "products": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "specialty": false,
            "active": true,
            "only_order_in_store": true,
            "price_type": "PER_UNIT",
            "price": 13,
            "target_price": false,
            "url_type": "none",
            "url": "https://example.com",
            "min_max": {
                "amount": {
                    "minimum": 14,
                    "maximum": 14,
                    "maximum_day": 12,
                    "maximum_week": 14
                },
                "weight": {
                    "minimum": 15,
                    "maximum": 16,
                    "maximum_day": 12,
                    "maximum_week": 15,
                    "suggested": 15
                },
                "persons": {
                    "minimum": 16,
                    "maximum": 16
                }
            },
            "id": 19,
            "allergens": [
                {
                    "id": 13,
                    "name": "Sesame"
                },
                {
                    "id": 12,
                    "name": "Nuts"
                },
                {
                    "id": 18,
                    "name": "Fish"
                }
            ],
            "category_id": 14,
            "price_look_up_code": "...",
            "code": "...",
            "seo": {
                "title": {
                    "en": "Explicabo dolorem delectus repellat necessitatibus cumque ullam et magnam ipsam."
                },
                "description": {
                    "en": "Nisi similique corporis repellendus. Quo autem eius incidunt aut sequi. Et atque animi eaque adipisci sapiente. Distinctio ut iusto aut."
                },
                "url": {
                    "en": "http://crist.info/dolores-aspernatur-velit-in-omnis-quam"
                }
            },
            "origin": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            }
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "specialty": true,
            "active": true,
            "only_order_in_store": false,
            "price_type": "PER_UNIT",
            "price": 13,
            "target_price": false,
            "url_type": "none",
            "url": "https://example.com",
            "min_max": {
                "amount": {
                    "minimum": 15,
                    "maximum": 10,
                    "maximum_day": 13,
                    "maximum_week": 15
                },
                "weight": {
                    "minimum": 17,
                    "maximum": 16,
                    "maximum_day": 19,
                    "maximum_week": 13,
                    "suggested": 12
                },
                "persons": {
                    "minimum": 19,
                    "maximum": 11
                }
            },
            "id": 12,
            "allergens": [
                {
                    "id": 17,
                    "name": "Lupine"
                },
                {
                    "id": 14,
                    "name": "Milk"
                },
                {
                    "id": 11,
                    "name": "Fish"
                }
            ],
            "category_id": 19,
            "price_look_up_code": "...",
            "code": "...",
            "seo": {
                "title": {
                    "en": "Laudantium laborum voluptatem qui tenetur facilis aliquam dignissimos impedit."
                },
                "description": {
                    "en": "Voluptas et ut tempore sint. Magnam et perspiciatis assumenda dicta expedita dolorem similique."
                },
                "url": {
                    "en": "http://hills.biz/facilis-et-harum-natus-eos-qui-molestias-dignissimos"
                }
            },
            "origin": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            }
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "specialty": false,
            "active": false,
            "only_order_in_store": false,
            "price_type": "PER_UNIT",
            "price": 12,
            "target_price": true,
            "url_type": "none",
            "url": "https://example.com",
            "min_max": {
                "amount": {
                    "minimum": 12,
                    "maximum": 14,
                    "maximum_day": 13,
                    "maximum_week": 13
                },
                "weight": {
                    "minimum": 16,
                    "maximum": 18,
                    "maximum_day": 14,
                    "maximum_week": 14,
                    "suggested": 11
                },
                "persons": {
                    "minimum": 12,
                    "maximum": 13
                }
            },
            "id": 14,
            "allergens": [
                {
                    "id": 19,
                    "name": "Lupine"
                },
                {
                    "id": 18,
                    "name": "Mollusc"
                },
                {
                    "id": 16,
                    "name": "Crustaceans"
                }
            ],
            "category_id": 10,
            "price_look_up_code": "...",
            "code": "...",
            "seo": {
                "title": {
                    "en": "Ex nostrum ut dolorem earum sit et ipsam porro."
                },
                "description": {
                    "en": "Eum ducimus nobis voluptatum pariatur accusantium at. Ullam qui eligendi expedita aut. Magnam asperiores et blanditiis dicta sequi ut unde."
                },
                "url": {
                    "en": "http://www.quitzon.com/"
                }
            },
            "origin": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            }
        }
    ],
    "shops": [
        {
            "name": "Mrs. Clotilde Lindgren DDS",
            "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": false,
            "delivery_use_intervals": true,
            "allow_invoices": false,
            "allow_order_comments": false,
            "allow_product_comments": false,
            "takeout_use_intervals": true,
            "allow_order_messages": true,
            "id": 14,
            "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
            },
            "url": "..."
        },
        {
            "name": "Prof. Maximillia Bode",
            "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,
            "allow_invoices": true,
            "allow_order_comments": false,
            "allow_product_comments": true,
            "takeout_use_intervals": false,
            "allow_order_messages": true,
            "id": 14,
            "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
            },
            "url": "..."
        },
        {
            "name": "Vena Willms",
            "active": false,
            "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,
            "allow_invoices": true,
            "allow_order_comments": true,
            "allow_product_comments": false,
            "takeout_use_intervals": true,
            "allow_order_messages": true,
            "id": 14,
            "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
            },
            "url": "..."
        }
    ],
    "code": "...",
    "id": 10,
    "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": "Dolorem ad architecto consequatur quaerat aut."
        },
        "description": {
            "en": "Illo deleniti consequatur adipisci iusto saepe id eos. Officiis totam ex labore nobis. Non eum quo pariatur debitis quia maiores delectus. Ipsum iure et et quisquam."
        },
        "url": {
            "en": "https://www.torphy.com/doloribus-nisi-distinctio-incidunt-atque-repellendus-repudiandae-sequi-repellat"
        }
    }
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.8.0 stable