Order the Categories

POST /company/shops/@shop_id/categories/order

Request

Authentication

This endpoint requires authentication.

Header Value
Authorization Set the value to Bearer + + access_token

Body

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

A dictionary with fields

Field Type Description
categories_order [Int] Array of Int

Example request 1

POST /company/shops/@shop_id/categories/order HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.10.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 70
{
    "categories_order": [
        15,
        19,
        16
    ]
}

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
code String? Nullable. A custom code. You can set this to your own code and use this field to map your categories to Bakeronline categories
id Int ID of the category
banner Image? Nullable.
overview_image Image? Nullable.
seo company.SeoData Optional. The category's webpage search engine metatags

Example response 1

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

[
    {
        "name": "Eunice Abernathy",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": true,
        "code": "...",
        "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
                }
            ],
            "file_id": 12,
            "white_background": false
        },
        "overview_image": {
            "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
                }
            ],
            "file_id": 11,
            "white_background": false
        },
        "seo": {
            "title": {
                "en": "Enim dolorem sunt quam quibusdam incidunt in pariatur iste et."
            },
            "description": {
                "en": "Adipisci sed hic eius tenetur maiores qui. Eveniet sequi rerum laborum qui. Sed impedit dolor sint dignissimos non animi libero. Aut nihil quia excepturi eum."
            },
            "url": {
                "en": "http://www.nicolas.com/et-error-corrupti-expedita-quia-explicabo.html"
            }
        }
    },
    {
        "name": "Maxime Langosh",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": true,
        "only_order_in_store": true,
        "code": "...",
        "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
                }
            ],
            "file_id": 11,
            "white_background": true
        },
        "overview_image": {
            "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
                }
            ],
            "file_id": 13,
            "white_background": true
        },
        "seo": {
            "title": {
                "en": "Deleniti commodi iste aut est et et et ut et veritatis deleniti."
            },
            "description": {
                "en": "Quidem dolorum suscipit corrupti corrupti dignissimos exercitationem tenetur voluptatem. Expedita vero sed et rerum. Eaque fugit quaerat officiis earum consequatur."
            },
            "url": {
                "en": "https://www.feest.com/deserunt-et-ea-aut-laudantium"
            }
        }
    },
    {
        "name": "Uriah Mann",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "only_order_in_store": true,
        "code": "...",
        "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
                }
            ],
            "file_id": 19,
            "white_background": false
        },
        "overview_image": {
            "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
                }
            ],
            "file_id": 19,
            "white_background": false
        },
        "seo": {
            "title": {
                "en": "Esse non incidunt atque necessitatibus provident natus nulla eos."
            },
            "description": {
                "en": "Est voluptatum quisquam cum nisi et ipsum maiores ducimus. Nobis non modi ipsam voluptatibus. Rem perspiciatis eum quidem ea eos debitis pariatur."
            },
            "url": {
                "en": "http://hegmann.com/possimus-laboriosam-fugiat-voluptatibus-quo.html"
            }
        }
    }
]
This is a development version Do not use this version in production
1.10.0 development