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/18/categories HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 0.2.1
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 |
| 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: 3744
[
{
"name": "Colby Effertz",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"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
}
],
"white_background": false
},
"seo": {
"title": {
"en": "Velit unde eum blanditiis illo modi deleniti."
},
"description": {
"en": "Est libero sed non earum qui eos voluptas esse. Sit praesentium odio ut ea sit. Et et sint incidunt illum."
},
"url": {
"en": "http://www.vonrueden.com/"
}
}
},
{
"name": "Camryn Schiller",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"id": 13,
"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": "Neque voluptatem ad expedita est fugiat et voluptas vel officia."
},
"description": {
"en": "Quidem quibusdam beatae enim. Perspiciatis et dolor explicabo a nihil."
},
"url": {
"en": "http://www.cormier.org/sit-est-ab-ullam-dolores"
}
}
},
{
"name": "Hassan Wunsch IV",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"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": false
},
"seo": {
"title": {
"en": "Reiciendis nam sed blanditiis non animi numquam quia."
},
"description": {
"en": "Soluta adipisci debitis et occaecati ullam commodi. Omnis maiores sint doloremque distinctio ut ipsa possimus quia. Aliquam provident temporibus voluptatem reiciendis molestiae sit laborum voluptas."
},
"url": {
"en": "http://frami.org/sequi-et-aut-et-qui"
}
}
}
]