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/14/categories HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.0.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: 3805
[
{
"name": "Jane Bradtke",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"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": true
},
"seo": {
"title": {
"en": "Expedita sint tempora veniam accusantium vero minus perferendis nam ut tempore."
},
"description": {
"en": "Ea repellat ut est aut molestias. Natus harum aut ut deleniti."
},
"url": {
"en": "http://www.tremblay.com/"
}
}
},
{
"name": "Leta Barton",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"id": 18,
"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": "Sequi ut tempore corrupti aliquam odit voluptatum itaque eveniet magnam dolorum ullam."
},
"description": {
"en": "Est quasi consequatur debitis non et. Blanditiis non non voluptatum provident. Consequatur commodi sint nihil earum molestias. Velit cumque est laborum eum."
},
"url": {
"en": "http://www.hackett.org/dolorum-sed-molestiae-libero-soluta-enim-dolor"
}
}
},
{
"name": "Bonita O'Kon DVM",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"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
}
],
"white_background": false
},
"seo": {
"title": {
"en": "Corporis quidem et culpa voluptas explicabo provident ea."
},
"description": {
"en": "Hic tempora fuga tempore officiis. Atque vitae et numquam dolor. Asperiores quidem quam quidem dignissimos nostrum consequatur officiis."
},
"url": {
"en": "http://lockman.info/sed-quia-veniam-autem"
}
}
}
]