Get category by id

GET /shops/@shop/categories/@id

Request

Optional authentication

You can use authentication for this request, but it is not required. Always provide the access_token when you have one. It may affect the response.

Header Value
Authorization Optional. 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
shop Int An integer value
id Int An integer value

Example request 1

GET /shops/13/categories/12 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 0.3.0
Accept-Language: en-US,en;q=0.5

Response

Field Type Description
id Int Id of the category
name String Translated category name
banner Image? Nullable.
messages [String] Array of String
products [Product.detailed] Array of Product.detailed
seo company.SeoData Optional. Product page SEO metatags

Example response 1

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

{
    "id": 13,
    "name": "Kaya Hilpert I",
    "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
    },
    "messages": [
        "...",
        "...",
        "..."
    ],
    "products": [
        {
            "id": 16,
            "name": "...",
            "images": [
                {
                    "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
                },
                {
                    "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
                },
                {
                    "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
                }
            ],
            "price_type": "PER_UNIT",
            "target_price": true,
            "price": 16,
            "subtitle": "...",
            "description": "...",
            "allergens": [
                {
                    "id": 15,
                    "name": "Sulphite"
                },
                {
                    "id": 10,
                    "name": "Peanut"
                },
                {
                    "id": 14,
                    "name": "Soy"
                }
            ],
            "url": "https://example.com",
            "url_type": "none",
            "specialty": true,
            "favourite": true,
            "product_prices": [
                {
                    "id": 16,
                    "name": "...",
                    "price": 17
                },
                {
                    "id": 18,
                    "name": "...",
                    "price": 10
                },
                {
                    "id": 11,
                    "name": "...",
                    "price": 13
                }
            ],
            "optionsets": [
                {
                    "id": 13,
                    "name": "...",
                    "allow_attachment": true,
                    "options": [
                        {
                            "id": 11,
                            "name": "...",
                            "price_change": 11
                        },
                        {
                            "id": 17,
                            "name": "...",
                            "price_change": 10
                        },
                        {
                            "id": 19,
                            "name": "...",
                            "price_change": 12
                        }
                    ]
                },
                {
                    "id": 14,
                    "name": "...",
                    "allow_attachment": true,
                    "options": [
                        {
                            "id": 11,
                            "name": "...",
                            "price_change": 19
                        },
                        {
                            "id": 18,
                            "name": "...",
                            "price_change": 12
                        },
                        {
                            "id": 13,
                            "name": "...",
                            "price_change": 14
                        }
                    ]
                },
                {
                    "id": 16,
                    "name": "...",
                    "allow_attachment": true,
                    "options": [
                        {
                            "id": 14,
                            "name": "...",
                            "price_change": 10
                        },
                        {
                            "id": 16,
                            "name": "...",
                            "price_change": 11
                        },
                        {
                            "id": 17,
                            "name": "...",
                            "price_change": 11
                        }
                    ]
                }
            ],
            "min_max": {
                "amount": {
                    "minimum": 10,
                    "maximum": 11,
                    "suggested": 14
                },
                "weight": {
                    "minimum": 13,
                    "maximum": 14,
                    "suggested": 16
                },
                "persons": {
                    "minimum": 10,
                    "maximum": 18,
                    "suggested": 15
                }
            },
            "info": [
                {
                    "name": "...",
                    "title": "...",
                    "text": "...",
                    "type": "HTML"
                },
                {
                    "name": "...",
                    "title": "...",
                    "text": "...",
                    "type": "HTML"
                },
                {
                    "name": "...",
                    "title": "...",
                    "text": "...",
                    "type": "HTML"
                }
            ]
        },
        {
            "id": 17,
            "name": "...",
            "images": [
                {
                    "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
                },
                {
                    "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
                },
                {
                    "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
                }
            ],
            "price_type": "PER_UNIT",
            "target_price": false,
            "price": 13,
            "subtitle": "...",
            "description": "...",
            "allergens": [
                {
                    "id": 15,
                    "name": "Egg"
                },
                {
                    "id": 16,
                    "name": "Sesame"
                },
                {
                    "id": 18,
                    "name": "Egg"
                }
            ],
            "url": "https://example.com",
            "url_type": "none",
            "specialty": true,
            "favourite": true,
            "product_prices": [
                {
                    "id": 12,
                    "name": "...",
                    "price": 19
                },
                {
                    "id": 16,
                    "name": "...",
                    "price": 12
                },
                {
                    "id": 13,
                    "name": "...",
                    "price": 15
                }
            ],
            "optionsets": [
                {
                    "id": 14,
                    "name": "...",
                    "allow_attachment": true,
                    "options": [
                        {
                            "id": 17,
                            "name": "...",
                            "price_change": 13
                        },
                        {
                            "id": 19,
                            "name": "...",
                            "price_change": 13
                        },
                        {
                            "id": 16,
                            "name": "...",
                            "price_change": 10
                        }
                    ]
                },
                {
                    "id": 16,
                    "name": "...",
                    "allow_attachment": true,
                    "options": [
                        {
                            "id": 17,
                            "name": "...",
                            "price_change": 16
                        },
                        {
                            "id": 16,
                            "name": "...",
                            "price_change": 15
                        },
                        {
                            "id": 17,
                            "name": "...",
                            "price_change": 19
                        }
                    ]
                },
                {
                    "id": 17,
                    "name": "...",
                    "allow_attachment": false,
                    "options": [
                        {
                            "id": 15,
                            "name": "...",
                            "price_change": 18
                        },
                        {
                            "id": 19,
                            "name": "...",
                            "price_change": 17
                        },
                        {
                            "id": 18,
                            "name": "...",
                            "price_change": 18
                        }
                    ]
                }
            ],
            "min_max": {
                "amount": {
                    "minimum": 15,
                    "maximum": 12,
                    "suggested": 13
                },
                "weight": {
                    "minimum": 15,
                    "maximum": 15,
                    "suggested": 19
                },
                "persons": {
                    "minimum": 15,
                    "maximum": 12,
                    "suggested": 12
                }
            },
            "info": [
                {
                    "name": "...",
                    "title": "...",
                    "text": "...",
                    "type": "HTML"
                },
                {
                    "name": "...",
                    "title": "...",
                    "text": "...",
                    "type": "HTML"
                },
                {
                    "name": "...",
                    "title": "...",
                    "text": "...",
                    "type": "HTML"
                }
            ]
        },
        {
            "id": 11,
            "name": "...",
            "images": [
                {
                    "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
                },
                {
                    "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
                },
                {
                    "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
                }
            ],
            "price_type": "PER_UNIT",
            "target_price": false,
            "price": 10,
            "subtitle": "...",
            "description": "...",
            "allergens": [
                {
                    "id": 14,
                    "name": "Lactose"
                },
                {
                    "id": 11,
                    "name": "Lactose"
                },
                {
                    "id": 12,
                    "name": "Gluten"
                }
            ],
            "url": "https://example.com",
            "url_type": "none",
            "specialty": true,
            "favourite": false,
            "product_prices": [
                {
                    "id": 18,
                    "name": "...",
                    "price": 12
                },
                {
                    "id": 10,
                    "name": "...",
                    "price": 16
                },
                {
                    "id": 13,
                    "name": "...",
                    "price": 16
                }
            ],
            "optionsets": [
                {
                    "id": 11,
                    "name": "...",
                    "allow_attachment": true,
                    "options": [
                        {
                            "id": 14,
                            "name": "...",
                            "price_change": 15
                        },
                        {
                            "id": 13,
                            "name": "...",
                            "price_change": 12
                        },
                        {
                            "id": 19,
                            "name": "...",
                            "price_change": 10
                        }
                    ]
                },
                {
                    "id": 13,
                    "name": "...",
                    "allow_attachment": true,
                    "options": [
                        {
                            "id": 15,
                            "name": "...",
                            "price_change": 13
                        },
                        {
                            "id": 14,
                            "name": "...",
                            "price_change": 14
                        },
                        {
                            "id": 13,
                            "name": "...",
                            "price_change": 12
                        }
                    ]
                },
                {
                    "id": 13,
                    "name": "...",
                    "allow_attachment": true,
                    "options": [
                        {
                            "id": 14,
                            "name": "...",
                            "price_change": 15
                        },
                        {
                            "id": 14,
                            "name": "...",
                            "price_change": 18
                        },
                        {
                            "id": 17,
                            "name": "...",
                            "price_change": 13
                        }
                    ]
                }
            ],
            "min_max": {
                "amount": {
                    "minimum": 15,
                    "maximum": 13,
                    "suggested": 19
                },
                "weight": {
                    "minimum": 16,
                    "maximum": 10,
                    "suggested": 17
                },
                "persons": {
                    "minimum": 14,
                    "maximum": 11,
                    "suggested": 16
                }
            },
            "info": [
                {
                    "name": "...",
                    "title": "...",
                    "text": "...",
                    "type": "HTML"
                },
                {
                    "name": "...",
                    "title": "...",
                    "text": "...",
                    "type": "HTML"
                },
                {
                    "name": "...",
                    "title": "...",
                    "text": "...",
                    "type": "HTML"
                }
            ]
        }
    ],
    "seo": {
        "title": {
            "en": "Veniam praesentium suscipit quis aut laudantium eum ad officia."
        },
        "description": {
            "en": "Quae quam commodi praesentium et quis quis. Iusto voluptas cupiditate nisi eum nulla velit dolorem. Eaque explicabo sapiente dignissimos in."
        },
        "url": {
            "en": "http://www.torp.info/quia-non-nihil-pariatur-atque-aut.html"
        }
    }
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
0.3.0 stable