company.Category.detailed

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
shop_ids [Int] Minimum 1. IDs of the shops the category will be available for
seo company.SeoData Optional. The category's webpage search engine metatags
product_ids [Int] Optional. Set the order of the products in a category by setting the IDs of the products in the right order. You can't add or remove products, only change the order. Don't set this field if you don't want to make changes.

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
products [company.Product.simple] Array of company.Product.simple
shops [company.Shop.simple] Array of company.Shop.simple
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": "Dr. Laisha Keeling",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": false,
    "only_order_in_store": false,
    "shop_ids": [
        12,
        14,
        11
    ],
    "seo": {
        "title": {
            "en": "Et non non asperiores est nobis quidem saepe."
        },
        "description": {
            "en": "Aut est voluptas vel ea qui. Autem nobis nulla laboriosam. Adipisci rem ut ducimus."
        },
        "url": {
            "en": "http://www.gottlieb.com/explicabo-corrupti-dolor-asperiores-dolor"
        }
    },
    "product_ids": [
        19,
        13,
        13
    ]
}

Response

When returned in a response.

Example 1

{
    "name": "Oswaldo Howell",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": true,
    "only_order_in_store": false,
    "products": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "specialty": false,
            "active": false,
            "only_order_in_store": false,
            "price_type": "PER_UNIT",
            "price": 18,
            "target_price": true,
            "url_type": "none",
            "url": "https://example.com",
            "min_max": {
                "amount": {
                    "minimum": 13,
                    "maximum": 17,
                    "maximum_day": 10,
                    "maximum_week": 17
                },
                "weight": {
                    "minimum": 16,
                    "maximum": 17,
                    "maximum_day": 13,
                    "maximum_week": 11,
                    "suggested": 16
                },
                "persons": {
                    "minimum": 18,
                    "maximum": 13
                }
            },
            "id": 15,
            "allergens": [
                {
                    "id": 18,
                    "name": "Egg"
                },
                {
                    "id": 13,
                    "name": "Sulphite"
                },
                {
                    "id": 16,
                    "name": "Mollusc"
                }
            ],
            "category_id": 10,
            "price_look_up_code": "...",
            "code": "...",
            "seo": {
                "title": {
                    "en": "Deleniti aut qui nihil quia dolores."
                },
                "description": {
                    "en": "Animi quis voluptas autem et nesciunt rerum. Praesentium quos et labore est consectetur harum laboriosam. Occaecati exercitationem dicta ipsa cum."
                },
                "url": {
                    "en": "http://west.com/voluptas-eaque-atque-quia-non-iure-totam-eaque"
                }
            }
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "specialty": true,
            "active": false,
            "only_order_in_store": true,
            "price_type": "PER_UNIT",
            "price": 17,
            "target_price": true,
            "url_type": "none",
            "url": "https://example.com",
            "min_max": {
                "amount": {
                    "minimum": 19,
                    "maximum": 16,
                    "maximum_day": 18,
                    "maximum_week": 14
                },
                "weight": {
                    "minimum": 19,
                    "maximum": 12,
                    "maximum_day": 14,
                    "maximum_week": 16,
                    "suggested": 15
                },
                "persons": {
                    "minimum": 15,
                    "maximum": 15
                }
            },
            "id": 13,
            "allergens": [
                {
                    "id": 18,
                    "name": "Egg"
                },
                {
                    "id": 12,
                    "name": "Lupine"
                },
                {
                    "id": 16,
                    "name": "Soy"
                }
            ],
            "category_id": 11,
            "price_look_up_code": "...",
            "code": "...",
            "seo": {
                "title": {
                    "en": "Et ipsa id alias rem adipisci iusto adipisci est nesciunt."
                },
                "description": {
                    "en": "Facere eum eum iusto neque quo cupiditate aut eaque. Nihil praesentium corrupti veniam fuga atque consequatur. Molestiae ut porro eos soluta quasi voluptatem fuga."
                },
                "url": {
                    "en": "https://www.jacobs.com/autem-qui-alias-similique-vel-inventore-sed"
                }
            }
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "specialty": true,
            "active": true,
            "only_order_in_store": true,
            "price_type": "PER_UNIT",
            "price": 10,
            "target_price": true,
            "url_type": "none",
            "url": "https://example.com",
            "min_max": {
                "amount": {
                    "minimum": 13,
                    "maximum": 19,
                    "maximum_day": 11,
                    "maximum_week": 16
                },
                "weight": {
                    "minimum": 15,
                    "maximum": 10,
                    "maximum_day": 11,
                    "maximum_week": 14,
                    "suggested": 15
                },
                "persons": {
                    "minimum": 17,
                    "maximum": 17
                }
            },
            "id": 17,
            "allergens": [
                {
                    "id": 19,
                    "name": "Mustard"
                },
                {
                    "id": 12,
                    "name": "Fish"
                },
                {
                    "id": 16,
                    "name": "Soy"
                }
            ],
            "category_id": 14,
            "price_look_up_code": "...",
            "code": "...",
            "seo": {
                "title": {
                    "en": "Optio placeat omnis reiciendis voluptatem et."
                },
                "description": {
                    "en": "Recusandae a quaerat at veritatis qui ratione. Libero eum eos dolor a. Qui necessitatibus numquam porro autem ea repellendus dolor."
                },
                "url": {
                    "en": "http://www.waelchi.biz/sed-alias-rerum-consequatur-ea.html"
                }
            }
        }
    ],
    "shops": [
        {
            "name": "Burnice Jacobi",
            "active": true,
            "address": {
                "street": "Sint-Denijslaan",
                "nr": "96",
                "zipcode": "9000",
                "city": "Gent",
                "country": "BE",
                "position": {
                    "latitude": 1.54361,
                    "longitude": 0.45645
                }
            },
            "allow_comments": false,
            "allow_orders": true,
            "delivery_use_intervals": false,
            "id": 16,
            "avatar": {
                "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
            },
            "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
            }
        },
        {
            "name": "Andreanne Hammes",
            "active": true,
            "address": {
                "street": "Sint-Denijslaan",
                "nr": "96",
                "zipcode": "9000",
                "city": "Gent",
                "country": "BE",
                "position": {
                    "latitude": 1.54361,
                    "longitude": 0.45645
                }
            },
            "allow_comments": true,
            "allow_orders": true,
            "delivery_use_intervals": false,
            "id": 10,
            "avatar": {
                "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
            },
            "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
            }
        },
        {
            "name": "Maynard Cole",
            "active": false,
            "address": {
                "street": "Sint-Denijslaan",
                "nr": "96",
                "zipcode": "9000",
                "city": "Gent",
                "country": "BE",
                "position": {
                    "latitude": 1.54361,
                    "longitude": 0.45645
                }
            },
            "allow_comments": true,
            "allow_orders": false,
            "delivery_use_intervals": false,
            "id": 16,
            "avatar": {
                "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
            },
            "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
            }
        }
    ],
    "id": 17,
    "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": "Ut corporis magni totam odio."
        },
        "description": {
            "en": "A nihil quas aut officia. Nisi ducimus reprehenderit soluta temporibus. Quia aut ut porro quo quod qui non ipsa."
        },
        "url": {
            "en": "http://ryan.org/"
        }
    }
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.5.0 stable