GET /company/shops/@id/categories
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 | Return all categories of the given shop |
GET /company/shops/15/categories HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.8.0
Accept-Language: en-US,en;q=0.5
Array of company.Category.simple: [company.Category.simple]
| 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 |
| 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. |
| 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: 3952
[
{
"name": "Mr. Conner Dickens",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"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
}
],
"white_background": true
},
"seo": {
"title": {
"en": "Officiis vitae cum corrupti hic voluptas."
},
"description": {
"en": "Dolorum maiores unde quis culpa. Molestiae repellendus voluptatem est voluptas. Esse suscipit iste dignissimos vero earum ea. Ut dolor sit voluptates molestiae delectus sequi ipsum labore."
},
"url": {
"en": "http://tromp.info/excepturi-dicta-minima-et-rerum"
}
}
},
{
"name": "Alba Heathcote",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"code": "...",
"id": 17,
"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
},
"seo": {
"title": {
"en": "Vitae doloribus itaque aperiam earum perferendis minima voluptate."
},
"description": {
"en": "Et officiis necessitatibus quas quae. Fugiat architecto possimus voluptas. Sit quia voluptatem hic quod deleniti est iure nihil."
},
"url": {
"en": "http://www.beer.net/"
}
}
},
{
"name": "Ena Hill",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"code": "...",
"id": 19,
"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": "Delectus aut aspernatur ut ea placeat excepturi iure amet."
},
"description": {
"en": "Quaerat ipsam quasi exercitationem dolores nisi magnam et quis. Voluptate fuga ratione quae laboriosam. Asperiores ex quisquam nam. Quod maxime consequatur reiciendis."
},
"url": {
"en": "https://schroeder.info/quia-neque-qui-deleniti-laudantium-rerum.html"
}
}
}
]