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/19 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.5.1
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: 13399

{
    "name": "Virgil Gleichner",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": true,
    "only_order_in_store": false,
    "products": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "specialty": true,
            "active": false,
            "only_order_in_store": true,
            "price_type": "PER_UNIT",
            "price": 10,
            "target_price": true,
            "url_type": "none",
            "url": "https://example.com",
            "min_max": {
                "amount": {
                    "minimum": 16,
                    "maximum": 13,
                    "maximum_day": 16,
                    "maximum_week": 19
                },
                "weight": {
                    "minimum": 11,
                    "maximum": 11,
                    "maximum_day": 19,
                    "maximum_week": 17,
                    "suggested": 15
                },
                "persons": {
                    "minimum": 14,
                    "maximum": 13
                }
            },
            "id": 15,
            "allergens": [
                {
                    "id": 14,
                    "name": "Sesame"
                },
                {
                    "id": 10,
                    "name": "Mollusc"
                },
                {
                    "id": 15,
                    "name": "Celery"
                }
            ],
            "category_id": 13,
            "price_look_up_code": "...",
            "code": "...",
            "seo": {
                "title": {
                    "en": "Incidunt neque aut quo perspiciatis rerum et sed veniam similique esse."
                },
                "description": {
                    "en": "Officia ut similique odio. Voluptatum earum amet numquam beatae. Inventore consequuntur inventore libero natus explicabo rerum sed quae."
                },
                "url": {
                    "en": "http://legros.info/eius-doloribus-ea-et.html"
                }
            }
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "specialty": false,
            "active": true,
            "only_order_in_store": true,
            "price_type": "PER_UNIT",
            "price": 18,
            "target_price": true,
            "url_type": "none",
            "url": "https://example.com",
            "min_max": {
                "amount": {
                    "minimum": 18,
                    "maximum": 17,
                    "maximum_day": 10,
                    "maximum_week": 16
                },
                "weight": {
                    "minimum": 18,
                    "maximum": 18,
                    "maximum_day": 19,
                    "maximum_week": 18,
                    "suggested": 11
                },
                "persons": {
                    "minimum": 14,
                    "maximum": 15
                }
            },
            "id": 17,
            "allergens": [
                {
                    "id": 14,
                    "name": "Celery"
                },
                {
                    "id": 12,
                    "name": "Nuts"
                },
                {
                    "id": 12,
                    "name": "Egg"
                }
            ],
            "category_id": 18,
            "price_look_up_code": "...",
            "code": "...",
            "seo": {
                "title": {
                    "en": "Laboriosam laborum rerum autem in maxime molestiae quia debitis."
                },
                "description": {
                    "en": "Voluptatibus voluptas sint non eum dolor vel omnis. Ut tenetur aut ea autem quia sint sint. Earum ipsum aut excepturi eos aperiam est enim. Qui provident eum ut nulla exercitationem harum."
                },
                "url": {
                    "en": "http://www.dickinson.net/neque-reprehenderit-sunt-eum-et-vitae"
                }
            }
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "specialty": false,
            "active": true,
            "only_order_in_store": true,
            "price_type": "PER_UNIT",
            "price": 10,
            "target_price": true,
            "url_type": "none",
            "url": "https://example.com",
            "min_max": {
                "amount": {
                    "minimum": 14,
                    "maximum": 10,
                    "maximum_day": 13,
                    "maximum_week": 14
                },
                "weight": {
                    "minimum": 12,
                    "maximum": 15,
                    "maximum_day": 12,
                    "maximum_week": 19,
                    "suggested": 13
                },
                "persons": {
                    "minimum": 16,
                    "maximum": 12
                }
            },
            "id": 14,
            "allergens": [
                {
                    "id": 18,
                    "name": "Mustard"
                },
                {
                    "id": 13,
                    "name": "Celery"
                },
                {
                    "id": 19,
                    "name": "Sulphite"
                }
            ],
            "category_id": 12,
            "price_look_up_code": "...",
            "code": "...",
            "seo": {
                "title": {
                    "en": "Eveniet qui maiores sit voluptatem dolor quidem molestiae molestiae veritatis sapiente."
                },
                "description": {
                    "en": "Eveniet nulla quae et. Laborum nulla nihil perspiciatis. Ipsum et nihil nihil at. Quisquam quasi voluptas molestias cumque quo."
                },
                "url": {
                    "en": "http://www.hyatt.com/impedit-temporibus-dicta-modi-reprehenderit"
                }
            }
        }
    ],
    "shops": [
        {
            "name": "Zelda Mills",
            "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": true,
            "id": 12,
            "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": "Jessyca Hane DVM",
            "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,
            "id": 18,
            "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": false
            }
        },
        {
            "name": "Andrew VonRueden Jr.",
            "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": false,
            "allow_invoices": 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": 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": false
            }
        }
    ],
    "id": 12,
    "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": "Omnis perspiciatis laboriosam dolorem dolor necessitatibus."
        },
        "description": {
            "en": "Quia quae sit nemo est rerum. Qui commodi dolor iste accusamus quis. Sunt blanditiis quia deleniti architecto voluptatem. Cumque ut distinctio quia a voluptas exercitationem est."
        },
        "url": {
            "en": "http://little.biz/amet-est-reprehenderit-quaerat-modi"
        }
    }
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.5.1 stable