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": "Herminia Dooley DVM",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": true,
    "only_order_in_store": true,
    "seo": {
        "title": {
            "en": "Ut soluta mollitia aperiam deleniti eaque itaque ut consequatur."
        },
        "description": {
            "en": "Est accusantium aut quia est placeat cupiditate asperiores quo. Sunt libero voluptas delectus nam cumque ut. Numquam quod ullam autem quod."
        },
        "url": {
            "en": "https://www.shanahan.com/aperiam-ipsum-cumque-deleniti-ad-vel-sunt-est-dolores"
        }
    }
}

Response

When returned in a response.

Example 1

{
    "name": "Hosea Farrell",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": false,
    "only_order_in_store": true,
    "id": 16,
    "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": false
    },
    "seo": {
        "title": {
            "en": "Hic non adipisci omnis qui dicta accusantium explicabo quaerat pariatur et."
        },
        "description": {
            "en": "Sit dicta officiis nobis. Omnis et esse consectetur blanditiis amet ut earum. Consectetur eligendi harum voluptatem est. Maxime et magni ipsam maxime est est culpa."
        },
        "url": {
            "en": "http://www.rogahn.com/ipsum-earum-impedit-incidunt-dignissimos-quia-dolor.html"
        }
    }
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
0.3.0 stable