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.0.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: 13250

{
    "name": "Weston Leuschke",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": false,
    "only_order_in_store": true,
    "products": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "specialty": false,
            "active": true,
            "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": 17,
                    "maximum": 13,
                    "maximum_day": 15,
                    "maximum_week": 12
                },
                "weight": {
                    "minimum": 19,
                    "maximum": 14,
                    "maximum_day": 14,
                    "maximum_week": 14,
                    "suggested": 16
                },
                "persons": {
                    "minimum": 19,
                    "maximum": 16
                }
            },
            "id": 14,
            "allergens": [
                {
                    "id": 16,
                    "name": "Peanut"
                },
                {
                    "id": 19,
                    "name": "Milk"
                },
                {
                    "id": 17,
                    "name": "Celery"
                }
            ],
            "category_id": 10,
            "price_look_up_code": "...",
            "seo": {
                "title": {
                    "en": "Dolores magni rerum et illum dolores accusamus quia temporibus et autem et."
                },
                "description": {
                    "en": "Dicta qui sed quis explicabo illo. Minus quae provident nemo quibusdam sit. Quia id consequatur ea iusto."
                },
                "url": {
                    "en": "https://damore.com/ipsa-quae-hic-nisi-sint-veniam-exercitationem-et.html"
                }
            },
            "code": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "specialty": true,
            "active": true,
            "only_order_in_store": true,
            "price_type": "PER_UNIT",
            "price": 11,
            "target_price": true,
            "url_type": "none",
            "url": "https://example.com",
            "min_max": {
                "amount": {
                    "minimum": 16,
                    "maximum": 18,
                    "maximum_day": 11,
                    "maximum_week": 13
                },
                "weight": {
                    "minimum": 17,
                    "maximum": 18,
                    "maximum_day": 11,
                    "maximum_week": 13,
                    "suggested": 19
                },
                "persons": {
                    "minimum": 12,
                    "maximum": 11
                }
            },
            "id": 14,
            "allergens": [
                {
                    "id": 16,
                    "name": "Nuts"
                },
                {
                    "id": 18,
                    "name": "Sulphite"
                },
                {
                    "id": 19,
                    "name": "Mollusc"
                }
            ],
            "category_id": 18,
            "price_look_up_code": "...",
            "seo": {
                "title": {
                    "en": "Omnis quia molestias nam sit eveniet doloribus qui."
                },
                "description": {
                    "en": "Ipsum aliquid fugiat quidem placeat. Aut ipsum molestias sint soluta iure. In maiores atque non. Iste magni ipsum quos ipsa aspernatur reprehenderit eum."
                },
                "url": {
                    "en": "http://ferry.com/nihil-qui-fuga-expedita-pariatur-et"
                }
            },
            "code": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "specialty": false,
            "active": false,
            "only_order_in_store": true,
            "price_type": "PER_UNIT",
            "price": 11,
            "target_price": false,
            "url_type": "none",
            "url": "https://example.com",
            "min_max": {
                "amount": {
                    "minimum": 19,
                    "maximum": 12,
                    "maximum_day": 17,
                    "maximum_week": 13
                },
                "weight": {
                    "minimum": 19,
                    "maximum": 17,
                    "maximum_day": 17,
                    "maximum_week": 12,
                    "suggested": 15
                },
                "persons": {
                    "minimum": 19,
                    "maximum": 13
                }
            },
            "id": 16,
            "allergens": [
                {
                    "id": 16,
                    "name": "Sulphite"
                },
                {
                    "id": 11,
                    "name": "Fish"
                },
                {
                    "id": 19,
                    "name": "Mustard"
                }
            ],
            "category_id": 11,
            "price_look_up_code": "...",
            "seo": {
                "title": {
                    "en": "Qui tempora dolor veritatis itaque odio eveniet."
                },
                "description": {
                    "en": "Voluptates sapiente placeat non voluptatem unde. Et mollitia et et labore eos repudiandae. Illum aut aut sint reprehenderit et vel repellendus. Explicabo inventore facilis dolore."
                },
                "url": {
                    "en": "http://www.fay.com/assumenda-explicabo-aut-ipsum-numquam-ducimus-nostrum.html"
                }
            },
            "code": "..."
        }
    ],
    "shops": [
        {
            "name": "Dr. Murray Hickle V",
            "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": true,
            "delivery_use_intervals": true,
            "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": true
            }
        },
        {
            "name": "Corine Reichert",
            "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": false,
            "delivery_use_intervals": false,
            "id": 19,
            "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": "Carmella Kautzer 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,
            "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": true
            }
        }
    ],
    "id": 18,
    "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": "Sit animi voluptas quos et recusandae at."
        },
        "description": {
            "en": "Ut rerum nesciunt id et. Omnis sit maxime sed dolorum voluptatem. Totam aut molestias sit qui aliquid esse. Quos deleniti magnam quia. Enim dolor totam vel est cupiditate aut molestias."
        },
        "url": {
            "en": "http://oreilly.com/magnam-expedita-quis-aut-quo-omnis"
        }
    }
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.0.1 stable