Category.simple

Request

Fields when send to the api inside a request.

Field Type Description
id Int Id of the category
name String Translated category name
banner Image? Nullable.
only_order_in_store Bool Whether the products in this category can only get ordered in the store with a separate UI for the shop employees, and not in the public webshop. Note that you will never receive products with this property set to true if you are not authorized.
image Image? Nullable. Image that should be used in square environments, e.g. category overview
seo company.SeoData Optional. Product page SEO metatags

Response

Fields when returned by the api in a response.

Field Type Description
id Int Id of the category
name String Translated category name
banner Image? Nullable.
only_order_in_store Bool Whether the products in this category can only get ordered in the store with a separate UI for the shop employees, and not in the public webshop. Note that you will never receive products with this property set to true if you are not authorized.
image Image? Nullable. Image that should be used in square environments, e.g. category overview
seo company.SeoData Optional. Product page SEO metatags

Examples

Example 1

{
    "id": 19,
    "name": "Karelle Bartell",
    "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
    },
    "only_order_in_store": false,
    "image": {
        "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 facilis vel commodi voluptatibus ipsum debitis non reprehenderit."
        },
        "description": {
            "en": "Voluptatem et laborum ut occaecati qui quisquam blanditiis dignissimos. Pariatur distinctio non et fuga totam alias dolores."
        },
        "url": {
            "en": "http://greenholt.com/aut-quia-et-nam-ratione.html"
        }
    }
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.6.0 stable