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": "Jayden Jast",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": true,
    "only_order_in_store": true,
    "seo": {
        "title": {
            "en": "Quia voluptate harum impedit ut sint sed."
        },
        "description": {
            "en": "Necessitatibus dolor ipsum molestiae. Maxime distinctio laudantium esse veniam similique commodi ea ratione. Vero labore mollitia voluptatem ducimus sed suscipit soluta."
        },
        "url": {
            "en": "http://casper.info/sit-et-tenetur-quia-occaecati-a-cum.html"
        }
    }
}

Response

When returned in a response.

Example 1

{
    "name": "Dr. Kathryne Stiedemann",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": false,
    "only_order_in_store": true,
    "id": 15,
    "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": "Animi numquam sequi aut nisi assumenda omnis."
        },
        "description": {
            "en": "Porro beatae dolores qui labore explicabo explicabo id. Architecto quis quos atque. Aut totam quam suscipit dolore reprehenderit."
        },
        "url": {
            "en": "http://mante.com/dolor-voluptas-id-officia-illum"
        }
    }
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.2.0 stable