GET /company/categories/@id
This endpoint requires authentication.
Header | Value |
---|---|
Authorization | Set the value to Bearer + + access_token |
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 |
GET /company/categories/12 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.10.0
Accept-Language: en-US,en;q=0.5
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. |
overview_image | Image? | Nullable. |
seo | company.SeoData | Optional. The category's webpage search engine metatags |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 18123
{
"name": "Cyrus Collins",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"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": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 12,
"maximum": 13,
"maximum_day": 12,
"maximum_week": 14
},
"weight": {
"minimum": 18,
"maximum": 14,
"maximum_day": 13,
"maximum_week": 11,
"suggested": 15
},
"persons": {
"minimum": 14,
"maximum": 19
}
},
"id": 18,
"allergens": [
{
"id": 17,
"name": "Fish"
},
{
"id": 12,
"name": "Celery"
},
{
"id": 12,
"name": "Fish"
}
],
"category_id": 14,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Autem sed consequatur vel sed itaque eveniet sed odio atque dolor."
},
"description": {
"en": "Aut quaerat aspernatur eius accusantium eaque voluptates accusantium. Praesentium illum consequatur consectetur vel quidem. Ut dolor autem tempora impedit recusandae officia et ut."
},
"url": {
"en": "http://schuster.com/"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 17,
"stock": {
"soldout": true,
"amount": 13,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
14,
11,
14
],
"upfront": {
"upfront_use_default": true,
"upfront_type": "days",
"upfront_days": 16,
"upfront_time": "12:00",
"upfront_hours": 12,
"upfront_minutes": 10
},
"use_pickup_after": true,
"pickup_after": "12:00",
"use_pickup_before": false,
"pickup_before": "12:00",
"related_products": [
10,
10,
12
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 12,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 12,
"maximum": 11,
"maximum_day": 19,
"maximum_week": 11
},
"weight": {
"minimum": 13,
"maximum": 18,
"maximum_day": 19,
"maximum_week": 13,
"suggested": 18
},
"persons": {
"minimum": 17,
"maximum": 17
}
},
"id": 13,
"allergens": [
{
"id": 14,
"name": "Mustard"
},
{
"id": 17,
"name": "Sesame"
},
{
"id": 18,
"name": "Sesame"
}
],
"category_id": 13,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Incidunt quod aut est quos eos aut quis."
},
"description": {
"en": "Eos et occaecati at. Repudiandae voluptates magni eum cum nemo odio nisi. Libero dolorem voluptates cum dolor sunt eveniet."
},
"url": {
"en": "http://www.larkin.org/alias-recusandae-soluta-odit"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 12,
"stock": {
"soldout": true,
"amount": 10,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
10,
12,
17
],
"upfront": {
"upfront_use_default": false,
"upfront_type": "days",
"upfront_days": 15,
"upfront_time": "12:00",
"upfront_hours": 17,
"upfront_minutes": 18
},
"use_pickup_after": false,
"pickup_after": "12:00",
"use_pickup_before": false,
"pickup_before": "12:00",
"related_products": [
10,
17,
10
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 19,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 17,
"maximum": 14,
"maximum_day": 15,
"maximum_week": 13
},
"weight": {
"minimum": 18,
"maximum": 13,
"maximum_day": 13,
"maximum_week": 19,
"suggested": 14
},
"persons": {
"minimum": 14,
"maximum": 15
}
},
"id": 13,
"allergens": [
{
"id": 12,
"name": "Crustaceans"
},
{
"id": 11,
"name": "Peanut"
},
{
"id": 10,
"name": "Lactose"
}
],
"category_id": 11,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Saepe et impedit omnis vel necessitatibus omnis temporibus omnis sit."
},
"description": {
"en": "Enim at soluta dolore qui modi ex. Repellendus velit dicta ut quos perferendis earum ducimus. Harum fugiat est amet voluptates voluptate quae rem labore. Corporis atque et atque labore."
},
"url": {
"en": "http://www.kuhlman.com/"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 15,
"stock": {
"soldout": true,
"amount": 14,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
18,
18,
16
],
"upfront": {
"upfront_use_default": true,
"upfront_type": "days",
"upfront_days": 16,
"upfront_time": "12:00",
"upfront_hours": 13,
"upfront_minutes": 17
},
"use_pickup_after": false,
"pickup_after": "12:00",
"use_pickup_before": false,
"pickup_before": "12:00",
"related_products": [
15,
11,
18
]
}
],
"shops": [
{
"name": "Mrs. Providenci Blanda MD",
"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": false,
"allow_order_comments": true,
"allow_product_comments": true,
"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
}
],
"file_id": 15,
"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
}
],
"file_id": 16,
"white_background": false
},
"url": "..."
},
{
"name": "Bethel Reynolds",
"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": true,
"allow_invoices": false,
"allow_order_comments": false,
"allow_product_comments": true,
"takeout_use_intervals": true,
"allow_order_messages": 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
}
],
"file_id": 11,
"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
}
],
"file_id": 11,
"white_background": true
},
"url": "..."
},
{
"name": "Bethany Kerluke",
"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": 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
}
],
"file_id": 15,
"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
}
],
"file_id": 15,
"white_background": true
},
"url": "..."
}
],
"code": "...",
"id": 15,
"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
}
],
"file_id": 15,
"white_background": false
},
"overview_image": {
"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
}
],
"file_id": 19,
"white_background": true
},
"seo": {
"title": {
"en": "Quis totam eum ipsum nobis ad consequatur."
},
"description": {
"en": "Unde autem voluptatem vel eos. Tenetur sunt voluptatem quas provident beatae. Quas quaerat sunt autem delectus omnis magni aliquam."
},
"url": {
"en": "https://hahn.com/vel-corrupti-distinctio-reiciendis-dolor-voluptas-dolorem-excepturi.html"
}
}
}