GET /company/companies/@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 company |
GET /company/companies/19/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: 5813
[
{
"name": "Hipolito Emard",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"code": "...",
"id": 11,
"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
},
"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": 16,
"white_background": true
},
"seo": {
"title": {
"en": "Fuga id eos qui magnam sequi."
},
"description": {
"en": "Eaque iure qui ut dolor totam. Dolores et ratione numquam. Aut provident omnis quam unde laboriosam. Vel et facere qui aut."
},
"url": {
"en": "http://dooley.biz/"
}
}
},
{
"name": "Shaina Emard",
"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
}
],
"file_id": 12,
"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": 18,
"white_background": true
},
"seo": {
"title": {
"en": "Omnis doloremque id vel nesciunt qui facere deserunt doloribus."
},
"description": {
"en": "Consequatur vel ut quis necessitatibus. Officia iure molestiae sunt repudiandae aut nesciunt. Ipsam cum perspiciatis ad culpa ea in aut."
},
"url": {
"en": "http://www.keeling.com/exercitationem-voluptatem-dolor-quo-molestiae-magni"
}
}
},
{
"name": "Ayden Friesen",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"code": "...",
"id": 10,
"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": 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": 17,
"white_background": true
},
"seo": {
"title": {
"en": "Placeat aperiam inventore et incidunt ratione qui iusto laborum quod sint."
},
"description": {
"en": "Magni nemo dolore ad omnis est. Sunt fuga aut est fugit quidem temporibus nihil. Magnam error sed ullam maiores. Dolorum inventore ab tenetur mollitia."
},
"url": {
"en": "http://www.mcdermott.com/quo-rem-et-nihil-inventore-assumenda-nulla"
}
}
}
]