Get all the categories that belong to a shop

GET /company/shops/@id/categories

Request

Authentication

This endpoint requires authentication.

Header Value
Authorization Set the value to Bearer + + access_token

URL parameters

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

Example request 1 Retrieve categories

GET /company/shops/2930/categories HTTP/1.1
Host: api.bakeronline.be
Authorization: Bearer fd432238e5808528c0cbe67458d0278a6cf5ef1ccc56e2c6552a96e04fd0ff5a062ad3ce998c760d8c44a0c67dda045b3e1ad085bb111b19704163e71ff00e37415d44a8fcc2b7201ad4c5a2b7e0b2d42104c391a31fabddbf195ae71cad2cb6ee1dc2dd
X-VERSION: 1.5.0
Accept-Language: en-US,en;q=0.5

Response

Array of company.Category.simple: [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

Example response 1 Retrieve categories

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 1850

[
    {
        "id": 3873,
        "name": {
            "nl": "MediumOrchid"
        },
        "description": {
            "nl": "This is a random description"
        },
        "banner": null,
        "active": true,
        "only_order_in_store": false,
        "seo": {
            "title": [],
            "description": [],
            "url": []
        }
    },
    {
        "id": 3874,
        "name": {
            "nl": "BlanchedAlmond"
        },
        "description": {
            "nl": "This is a random description"
        },
        "banner": null,
        "active": true,
        "only_order_in_store": false,
        "seo": {
            "title": [],
            "description": [],
            "url": []
        }
    },
    {
        "id": 3875,
        "name": {
            "nl": "FireBrick"
        },
        "description": {
            "nl": "This is a random description"
        },
        "banner": null,
        "active": true,
        "only_order_in_store": false,
        "seo": {
            "title": [],
            "description": [],
            "url": []
        }
    },
    {
        "id": 3876,
        "name": {
            "nl": "MediumOrchid"
        },
        "description": {
            "nl": "This is a random description"
        },
        "banner": null,
        "active": true,
        "only_order_in_store": false,
        "seo": {
            "title": [],
            "description": [],
            "url": []
        }
    },
    {
        "id": 3877,
        "name": {
            "nl": "Silver"
        },
        "description": {
            "nl": "This is a random description"
        },
        "banner": null,
        "active": true,
        "only_order_in_store": false,
        "seo": {
            "title": [],
            "description": [],
            "url": []
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.5.2)
1.5.0 stable