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": "Rick Denesik",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": false,
    "only_order_in_store": true,
    "seo": {
        "title": {
            "en": "Repudiandae reprehenderit nemo alias veritatis atque ea et excepturi atque eum."
        },
        "description": {
            "en": "Ut alias harum molestiae laboriosam adipisci. Voluptas exercitationem sunt assumenda placeat eveniet sint dolore. Enim amet qui cum magni. Aut ut incidunt quia aliquam."
        },
        "url": {
            "en": "http://okon.com/omnis-maxime-dolores-magnam-temporibus-quo-sit-sint"
        }
    }
}

Response

When returned in a response.

Example 1

{
    "name": "Ryder Quigley",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": true,
    "only_order_in_store": false,
    "id": 13,
    "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": "Voluptates sit illo nemo fugit delectus quam id incidunt voluptas quam."
        },
        "description": {
            "en": "Sint quia quos non alias voluptatem qui. Beatae omnis est nemo delectus consequatur sint officia consequuntur. Quas laudantium eius at possimus nulla ut numquam. Aut magni in nam omnis et et ipsa."
        },
        "url": {
            "en": "https://www.simonis.net/ipsam-expedita-ea-possimus-eaque"
        }
    }
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.7.0 stable