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/19/categories HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.1.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: 3823
[
{
"name": "Prof. Morton Eichmann IV",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"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
}
],
"white_background": false
},
"seo": {
"title": {
"en": "Sunt voluptatem quis voluptas quas voluptatem asperiores."
},
"description": {
"en": "Error at dolores consectetur distinctio fugit cumque ad. Ut exercitationem voluptatum itaque dolorum et harum. Exercitationem ut animi officiis delectus."
},
"url": {
"en": "http://www.gibson.com/et-sit-quis-esse-cum-quod-eos-quo"
}
}
},
{
"name": "Miss Brandy Schoen",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"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": "Optio odio error quisquam reprehenderit blanditiis."
},
"description": {
"en": "Quia ea tenetur quod. Temporibus quisquam magni ea sint. Unde incidunt a aut ut. Voluptatem eligendi sit enim dolor."
},
"url": {
"en": "http://www.schoen.com/"
}
}
},
{
"name": "Roberta Ernser",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"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": "Accusantium unde dolor eaque omnis eos aut eaque qui et labore perspiciatis."
},
"description": {
"en": "Recusandae quia possimus doloribus repellat nobis recusandae. Non minus et voluptatibus est. Dignissimos aut eveniet ut eos autem."
},
"url": {
"en": "http://www.olson.biz/officia-sed-optio-cumque.html"
}
}
}
]