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

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
id Int ID of the category
banner Image? Nullable.
seo company.SeoData Optional. The category's webpage search engine metatags

Examples

Request

When used inside a request.

Example 1

{
    "name": {
        "nl": "string"
    },
    "description": {
        "nl": "string"
    },
    "active": true,
    "only_order_in_store": true,
    "seo": {
        "title": {
            "nl": "string"
        },
        "description": {
            "nl": "string"
        },
        "url": {
            "nl": "string"
        }
    }
}

Response

When returned in a response.

Example 1

{
    "name": {
        "nl": "string"
    },
    "description": {
        "nl": "string"
    },
    "active": true,
    "only_order_in_store": true,
    "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": {
            "nl": "string"
        },
        "description": {
            "nl": "string"
        },
        "url": {
            "nl": "string"
        }
    }
}
1.5.0 stable