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.10.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. |
| 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: 5966
[
{
"name": "Mrs. Kathryn Waters",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"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
}
],
"file_id": 19,
"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": 17,
"white_background": false
},
"seo": {
"title": {
"en": "Illum ad nulla explicabo maxime sequi distinctio sint maxime enim fugiat."
},
"description": {
"en": "Placeat qui quibusdam assumenda eum deleniti eum. Sit sed consequatur cupiditate non deleniti dolores. Libero iure repellat autem suscipit maiores molestiae placeat. Quaerat eos quia qui."
},
"url": {
"en": "http://grady.com/alias-quaerat-fugit-suscipit-temporibus-nulla-veritatis"
}
}
},
{
"name": "Prof. Leda Ernser V",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"code": "...",
"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
}
],
"file_id": 16,
"white_background": true
},
"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": 12,
"white_background": true
},
"seo": {
"title": {
"en": "Fugit omnis unde ipsam quod perspiciatis quisquam magni officia dolores commodi fuga."
},
"description": {
"en": "Quibusdam quia architecto reprehenderit vitae sunt. Eos qui voluptatibus at consectetur tempore. Earum omnis laborum qui eos."
},
"url": {
"en": "http://wilkinson.info/velit-iure-architecto-quia-rerum-quisquam-rem-veniam.html"
}
}
},
{
"name": "Jayda Walter",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"code": "...",
"id": 16,
"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": 19,
"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": 12,
"white_background": true
},
"seo": {
"title": {
"en": "Accusantium eum error corrupti id quia consequatur doloribus vitae possimus ipsam."
},
"description": {
"en": "Non aut aspernatur modi cumque impedit. Odit ipsam delectus optio est. Fugit et qui exercitationem qui consequuntur."
},
"url": {
"en": "http://witting.com/sint-vel-porro-nulla-quia-animi-fuga"
}
}
}
]