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/11/categories HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.5.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: 3876
[
{
"name": "Kylie Gutkowski",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"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": "Facere accusamus perspiciatis sit ut consequuntur quas doloremque consequatur."
},
"description": {
"en": "Non aspernatur minima sed nobis. Perferendis qui culpa dicta sed non aliquid. In mollitia blanditiis et eaque rerum. Ut nemo voluptates cupiditate inventore aut tempore autem."
},
"url": {
"en": "http://gusikowski.info/qui-qui-eligendi-vero-voluptatem"
}
}
},
{
"name": "Sheila Schmidt",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"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": "Tempore nostrum inventore pariatur maiores rerum eius corporis voluptate."
},
"description": {
"en": "Quos omnis et amet et doloremque iure modi. Minus expedita aperiam vero illo. Sed rerum nostrum similique delectus."
},
"url": {
"en": "http://kirlin.biz/"
}
}
},
{
"name": "Sabina Schumm",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"id": 14,
"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": "Rerum dolorem eligendi placeat quia et inventore totam dignissimos."
},
"description": {
"en": "Voluptates ipsum ullam unde facere. Sit animi debitis hic aut corrupti perferendis et. Consequatur facilis non ratione molestiae."
},
"url": {
"en": "http://vandervort.com/velit-impedit-ipsam-nesciunt-dolor-praesentium"
}
}
}
]