Create a category

POST /company/companies/@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	The company where to create a new category

Body

Pass the following properties via application/json or form encoding in the body of the request.

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
shop_ids	[Int]	Minimum 1. IDs of the shops the category will be available for
seo	company.SeoData	Optional. The category's webpage search engine metatags
product_ids	[Int]	Optional. Set the order of the products in a category by setting the IDs of the products in the right order. You can't add or remove products, only change the order. Don't set this field if you don't want to make changes.

Example request 1 Create basic category

POST /company/companies/2835/categories HTTP/1.1
Host: api.bakeronline.be
Authorization: Bearer d8b67c9243da22292fa2abc46fa95315626ab6be93103e4c559675ea7508423976bcee3825f582abefe012841ff0cc3bb84963e9ab951dbdfb0c059d71359ef27a7320fefec6a42edc654ff49142ef2065339fea234f089cd76f4ee863b0d00d919b1b26
X-VERSION: 1.5.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 231

{
    "name": {
        "es": "Grand"
    },
    "description": {
        "nl": "Groot",
        "en": "Big",
        "fr": "Grand"
    },
    "active": true,
    "only_order_in_store": false,
    "shop_ids": [
        2937
    ]
}

Example request 2 Creating a category should have minimum 1 shop

POST /company/companies/2835/categories HTTP/1.1
Host: api.bakeronline.be
Authorization: Bearer d8b67c9243da22292fa2abc46fa95315626ab6be93103e4c559675ea7508423976bcee3825f582abefe012841ff0cc3bb84963e9ab951dbdfb0c059d71359ef27a7320fefec6a42edc654ff49142ef2065339fea234f089cd76f4ee863b0d00d919b1b26
X-VERSION: 1.5.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 213

{
    "name": {
        "es": "Grand"
    },
    "description": {
        "nl": "Groot",
        "en": "Big",
        "fr": "Grand"
    },
    "active": true,
    "only_order_in_store": false,
    "shop_ids": []
}

Response

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
products	[company.Product.simple]	Array of company.Product.simple
shops	[company.Shop.simple]	Array of company.Shop.simple
id	Int	ID of the category
banner	Image?	Nullable.
seo	company.SeoData	Optional. The category's webpage search engine metatags

Example response 1 Create basic category

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


{
    "id": 3904,
    "name": {
        "es": "Grand",
        "nl": ""
    },
    "description": {
        "en": "Big",
        "fr": "Grand",
        "nl": "Groot"
    },
    "banner": null,
    "active": true,
    "only_order_in_store": false,
    "seo": {
        "title": [],
        "description": [],
        "url": []
    },
    "products": [],
    "shops": [
        {
            "id": 2937,
            "name": "Rise of the Buns",
            "active": true,
            "address": {
                "street": "Lauwersweg",
                "nr": "49",
                "zipcode": "5190",
                "city": "Damme",
                "country": "BE",
                "position": {
                    "latitude": 51.260197,
                    "longitude": 4.402771
                }
            },
            "avatar": {
                "resolutions": [
                    {
                        "src": "https://bakeronline.be/uploads/shop-avatars/2937/180x180/patisserie-dhondt-fr-niet-gebruiken.jpg",
                        "width": 252,
                        "height": 180
                    },
                    {
                        "src": "https://bakeronline.be/uploads/shop-avatars/2937/360x360/patisserie-dhondt-fr-niet-gebruiken.jpg",
                        "width": 300,
                        "height": 214
                    }
                ]
            },
            "banner": null,
            "allow_comments": false,
            "allow_orders": true,
            "delivery_use_intervals": false
        }
    ]
}

Example response 2 Creating a category should have minimum 1 shop

HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
Content-Length: 137


[
    {
        "code": "invalid_length",
        "message": "Expected an array with minimum 1",
        "field": "data.shop_ids"
    }
]

Version update available Please adjust your integration to the latest stable version (1.5.2)

1.5.0 stable