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": "Winifred Ward Sr.",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": false,
    "only_order_in_store": true,
    "seo": {
        "title": {
            "en": "Itaque quia nobis illo vitae voluptates adipisci."
        },
        "description": {
            "en": "Id et ut illum cum sit non rerum. Quia accusantium iure ut atque eligendi. Asperiores aut dolore ipsa numquam officia nobis. Facilis tempore nobis ut perferendis accusamus eos."
        },
        "url": {
            "en": "http://tillman.com/praesentium-laborum-rerum-ipsam-facere-molestias"
        }
    }
}

Response

When returned in a response.

Example 1

{
    "name": "Ms. Angelita Grady",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": true,
    "only_order_in_store": false,
    "id": 11,
    "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": "Consequatur dignissimos eligendi qui et quia aspernatur."
        },
        "description": {
            "en": "Quia aut quo illo maxime. Ratione sequi et accusantium dolor consequatur veniam dolores. Quidem fugit delectus expedita aut nisi deserunt. Iusto laborum et exercitationem error."
        },
        "url": {
            "en": "https://www.leannon.com/quibusdam-est-nesciunt-quasi-non-dolor-sequi"
        }
    }
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.5.1 stable