company.Category.simple

Request

Fields when send to the api inside a 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
seo company.SeoData Optional. The category's webpage search engine metatags
code String? Optional. Nullable. A custom code. You can set this to your own code and use this field to map your categories to Bakeronline categories

Response

Fields when returned by the api in a 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
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

Examples

Request

When used inside a request.

Example 1

{
    "name": "Russel Senger",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": true,
    "only_order_in_store": true,
    "seo": {
        "title": {
            "en": "Deserunt vel quidem eaque molestias et qui."
        },
        "description": {
            "en": "Dolorem tempora rerum aut ea aut. Aut eveniet vitae qui quibusdam officia hic aspernatur. Reprehenderit minus facere laboriosam tempora impedit. Consequuntur inventore quo mollitia est quas."
        },
        "url": {
            "en": "http://wolff.com/omnis-labore-ipsam-aliquid"
        }
    },
    "code": "..."
}

Response

When returned in a response.

Example 1

{
    "name": "Alexandrine Gutkowski",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": true,
    "only_order_in_store": true,
    "code": "...",
    "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
            }
        ],
        "file_id": 10,
        "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": true
    },
    "seo": {
        "title": {
            "en": "Alias enim occaecati dolorem quaerat et."
        },
        "description": {
            "en": "Dicta quia voluptas quia. Ea sit aut eos dicta. Saepe consectetur et iste molestias ullam a et."
        },
        "url": {
            "en": "http://considine.net/enim-voluptas-consectetur-non-impedit-perspiciatis.html"
        }
    }
}
This is a development version Do not use this version in production
1.10.0 development