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": "Jaleel Murray",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": false,
    "only_order_in_store": false,
    "seo": {
        "title": {
            "en": "Excepturi velit est ut vero sunt asperiores est."
        },
        "description": {
            "en": "Odit voluptatum omnis aut assumenda ipsam veniam. Numquam et minus nihil delectus quis. Magni molestias quae sed ut excepturi aut. Libero velit consequatur iste itaque aut molestias."
        },
        "url": {
            "en": "https://tillman.com/eveniet-deleniti-et-quia-qui.html"
        }
    }
}

Response

When returned in a response.

Example 1

{
    "name": "Dr. Geovany Abbott DDS",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": true,
    "only_order_in_store": false,
    "id": 19,
    "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": {
            "en": "Quia eaque ut alias ut ad natus esse."
        },
        "description": {
            "en": "Aperiam atque minus et sed quam. Rerum aliquid voluptas quod suscipit quaerat eos."
        },
        "url": {
            "en": "http://www.franecki.com/autem-quia-quia-labore-vel-modi-temporibus-laborum-voluptas.html"
        }
    }
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.5.0 stable