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.3.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 |
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: 3897
[
{
"name": "Tressa Bosco Jr.",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"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": false
},
"seo": {
"title": {
"en": "Ut rerum repellendus suscipit asperiores enim neque."
},
"description": {
"en": "Aut aut excepturi explicabo architecto vel rem. Ipsam aut porro tempora magnam vero nihil. Et doloremque ut sapiente aut harum rem."
},
"url": {
"en": "http://www.cruickshank.com/nulla-natus-id-beatae-corrupti-aperiam.html"
}
}
},
{
"name": "Prof. Rey Daniel",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"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": false
},
"seo": {
"title": {
"en": "Ducimus itaque voluptatibus perferendis numquam et voluptates minima magnam impedit."
},
"description": {
"en": "Aliquam architecto tenetur qui ipsa. Quidem quo quia voluptas est totam ea. Omnis perferendis incidunt odio animi velit. In quibusdam quasi rerum eos veniam ullam aspernatur."
},
"url": {
"en": "http://yost.com/sed-deleniti-consectetur-iste-amet-nulla"
}
}
},
{
"name": "Maria Kshlerin",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"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
}
],
"white_background": true
},
"seo": {
"title": {
"en": "Aperiam occaecati animi aut harum ducimus incidunt."
},
"description": {
"en": "Error nihil consequatur deserunt quidem iusto. A ex beatae quas ad aut rerum. Blanditiis facere quis quas id porro."
},
"url": {
"en": "https://quigley.com/ipsam-asperiores-quia-autem-voluptas.html"
}
}
}
]