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/11 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.6.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: 14344

{
    "name": "Carter Rodriguez",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": false,
    "only_order_in_store": false,
    "products": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "specialty": true,
            "active": true,
            "only_order_in_store": true,
            "price_type": "PER_UNIT",
            "price": 14,
            "target_price": true,
            "url_type": "none",
            "url": "https://example.com",
            "min_max": {
                "amount": {
                    "minimum": 13,
                    "maximum": 14,
                    "maximum_day": 13,
                    "maximum_week": 17
                },
                "weight": {
                    "minimum": 19,
                    "maximum": 18,
                    "maximum_day": 15,
                    "maximum_week": 17,
                    "suggested": 15
                },
                "persons": {
                    "minimum": 14,
                    "maximum": 19
                }
            },
            "id": 11,
            "allergens": [
                {
                    "id": 11,
                    "name": "Peanut"
                },
                {
                    "id": 15,
                    "name": "Celery"
                },
                {
                    "id": 11,
                    "name": "Crustaceans"
                }
            ],
            "category_id": 10,
            "price_look_up_code": "...",
            "code": "...",
            "seo": {
                "title": {
                    "en": "Est ut cupiditate dolores sequi ut qui."
                },
                "description": {
                    "en": "Dicta velit exercitationem similique quasi consequatur. Nihil sint fugit doloremque quaerat voluptatem sit. Ut aperiam libero autem aperiam. Animi voluptates hic at sit et id."
                },
                "url": {
                    "en": "http://towne.com/magni-est-ratione-a-qui-repellendus"
                }
            },
            "origin": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            }
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "specialty": true,
            "active": false,
            "only_order_in_store": true,
            "price_type": "PER_UNIT",
            "price": 19,
            "target_price": false,
            "url_type": "none",
            "url": "https://example.com",
            "min_max": {
                "amount": {
                    "minimum": 18,
                    "maximum": 15,
                    "maximum_day": 19,
                    "maximum_week": 15
                },
                "weight": {
                    "minimum": 19,
                    "maximum": 13,
                    "maximum_day": 11,
                    "maximum_week": 10,
                    "suggested": 19
                },
                "persons": {
                    "minimum": 10,
                    "maximum": 16
                }
            },
            "id": 14,
            "allergens": [
                {
                    "id": 18,
                    "name": "Peanut"
                },
                {
                    "id": 17,
                    "name": "Lupine"
                },
                {
                    "id": 15,
                    "name": "Fish"
                }
            ],
            "category_id": 16,
            "price_look_up_code": "...",
            "code": "...",
            "seo": {
                "title": {
                    "en": "Similique eius nulla dolorum voluptas dolor exercitationem qui nihil."
                },
                "description": {
                    "en": "Accusamus consequatur voluptatem et corporis fuga sint ut. Inventore non et et quisquam qui eum velit. Aperiam explicabo eligendi ullam beatae. Recusandae et maiores molestiae adipisci nesciunt."
                },
                "url": {
                    "en": "http://www.nitzsche.net/facilis-aut-sed-rerum"
                }
            },
            "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": 19,
                    "maximum": 19,
                    "maximum_day": 18,
                    "maximum_week": 11
                },
                "weight": {
                    "minimum": 19,
                    "maximum": 17,
                    "maximum_day": 10,
                    "maximum_week": 15,
                    "suggested": 18
                },
                "persons": {
                    "minimum": 10,
                    "maximum": 12
                }
            },
            "id": 19,
            "allergens": [
                {
                    "id": 12,
                    "name": "Sesame"
                },
                {
                    "id": 10,
                    "name": "Lactose"
                },
                {
                    "id": 15,
                    "name": "Soy"
                }
            ],
            "category_id": 10,
            "price_look_up_code": "...",
            "code": "...",
            "seo": {
                "title": {
                    "en": "Quam quis repudiandae enim aut deserunt ut velit delectus."
                },
                "description": {
                    "en": "Nulla et aliquid accusantium. Rerum non non nihil dignissimos aut. Eaque quo perferendis omnis dolorem qui maxime corrupti. Aut qui fuga quidem. Consequatur enim eveniet eum ducimus commodi facilis."
                },
                "url": {
                    "en": "http://mayert.com/quod-deleniti-adipisci-in-qui-quia-nobis.html"
                }
            },
            "origin": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            }
        }
    ],
    "shops": [
        {
            "name": "Prof. Demarcus Hickle",
            "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": false,
            "delivery_use_intervals": true,
            "allow_invoices": true,
            "allow_order_comments": true,
            "allow_product_comments": true,
            "takeout_use_intervals": true,
            "allow_order_messages": true,
            "id": 13,
            "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": "Victor Prohaska",
            "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": false,
            "allow_invoices": false,
            "allow_order_comments": false,
            "allow_product_comments": true,
            "takeout_use_intervals": false,
            "allow_order_messages": false,
            "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": true
            }
        },
        {
            "name": "Isaiah Conroy",
            "active": true,
            "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": false,
            "allow_invoices": false,
            "allow_order_comments": true,
            "allow_product_comments": false,
            "takeout_use_intervals": false,
            "allow_order_messages": 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": 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": true
            }
        }
    ],
    "id": 13,
    "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": "Rerum aut iure accusantium optio quia sit voluptate dolore consectetur voluptatum."
        },
        "description": {
            "en": "Dicta vitae error in culpa iusto perspiciatis. Hic nobis accusantium voluptate fugiat. Totam numquam molestias est ut explicabo aspernatur."
        },
        "url": {
            "en": "http://www.schaden.com/sint-alias-dolor-cupiditate-ut-cupiditate.html"
        }
    }
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.6.0 stable