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": {
        "nl": "string"
    },
    "description": {
        "nl": "string"
    },
    "active": true,
    "only_order_in_store": true,
    "shop_ids": [
        12,
        12,
        12
    ],
    "seo": {
        "title": {
            "nl": "string"
        },
        "description": {
            "nl": "string"
        },
        "url": {
            "nl": "string"
        }
    },
    "product_ids": [
        12,
        12,
        12
    ]
}

Response

When returned in a response.

Example 1

{
    "name": {
        "nl": "string"
    },
    "description": {
        "nl": "string"
    },
    "active": true,
    "only_order_in_store": true,
    "products": [
        {
            "id": 696,
            "name": {
                "nl": "Pecannoten"
            },
            "description": {
                "nl": ""
            },
            "specialty": false,
            "active": true,
            "only_order_in_store": false,
            "allergens": null,
            "price_look_up_code": "346962",
            "price_type": "MULTIPLE_CHOICE",
            "price": 6862,
            "target_price": false,
            "url_type": "none",
            "url": "http://desmedt.com/ut-voluptatem-eum-incidunt",
            "min_max": {
                "amount": {
                    "minimum": 0,
                    "maximum": null,
                    "maximum_day": null,
                    "maximum_week": null
                },
                "weight": {
                    "minimum": 0,
                    "maximum": null,
                    "maximum_day": null,
                    "maximum_week": null,
                    "suggested": null
                },
                "persons": {
                    "minimum": 0,
                    "maximum": null
                }
            },
            "seo": {
                "title": [],
                "description": [],
                "url": []
            },
            "code": null,
            "category_id": 384
        },
        {
            "id": 697,
            "name": {
                "nl": "Aardbeitaartje"
            },
            "description": {
                "nl": "Random product description"
            },
            "specialty": false,
            "active": true,
            "only_order_in_store": false,
            "allergens": [
                {
                    "id": 1,
                    "name": "1319"
                },
                {
                    "id": 2,
                    "name": "1320"
                },
                {
                    "id": 4,
                    "name": "1322"
                },
                {
                    "id": 5,
                    "name": "1323"
                },
                {
                    "id": 6,
                    "name": "1324"
                },
                {
                    "id": 7,
                    "name": "1325"
                },
                {
                    "id": 8,
                    "name": "1326"
                },
                {
                    "id": 10,
                    "name": "1328"
                },
                {
                    "id": 12,
                    "name": "1330"
                },
                {
                    "id": 13,
                    "name": "1331"
                },
                {
                    "id": 14,
                    "name": "1332"
                },
                {
                    "id": 15,
                    "name": "1333"
                }
            ],
            "price_look_up_code": "973803",
            "price_type": "PER_KILOGRAM",
            "price": 8192,
            "target_price": true,
            "url_type": "none",
            "url": "https://www.noel.org/possimus-itaque-atque-rerum",
            "min_max": {
                "amount": {
                    "minimum": 0,
                    "maximum": null,
                    "maximum_day": null,
                    "maximum_week": null
                },
                "weight": {
                    "minimum": 0,
                    "maximum": null,
                    "maximum_day": null,
                    "maximum_week": null,
                    "suggested": null
                },
                "persons": {
                    "minimum": 0,
                    "maximum": null
                }
            },
            "seo": {
                "title": [],
                "description": [],
                "url": []
            },
            "code": null,
            "category_id": 384
        },
        {
            "id": 696,
            "name": {
                "nl": "Pecannoten"
            },
            "description": {
                "nl": ""
            },
            "specialty": false,
            "active": true,
            "only_order_in_store": false,
            "allergens": null,
            "price_look_up_code": "346962",
            "price_type": "MULTIPLE_CHOICE",
            "price": 6862,
            "target_price": false,
            "url_type": "none",
            "url": "http://desmedt.com/ut-voluptatem-eum-incidunt",
            "min_max": {
                "amount": {
                    "minimum": 0,
                    "maximum": null,
                    "maximum_day": null,
                    "maximum_week": null
                },
                "weight": {
                    "minimum": 0,
                    "maximum": null,
                    "maximum_day": null,
                    "maximum_week": null,
                    "suggested": null
                },
                "persons": {
                    "minimum": 0,
                    "maximum": null
                }
            },
            "seo": {
                "title": [],
                "description": [],
                "url": []
            },
            "code": null,
            "category_id": 384
        }
    ],
    "shops": [
        {
            "id": 277,
            "name": "The Dough Below",
            "active": true,
            "address": {
                "street": "Verschuerenweg",
                "nr": "31",
                "zipcode": "6880",
                "city": "Luik",
                "country": "BE",
                "position": {
                    "latitude": 51.05,
                    "longitude": 3.71667
                }
            },
            "avatar": {
                "resolutions": [
                    {
                        "src": "https://bakeronline.be/uploads/shop-avatars/277/180x180/bakkerij-van-hecke-iepenstraat.jpg",
                        "width": 178,
                        "height": 178
                    }
                ]
            },
            "banner": {
                "resolutions": [
                    {
                        "src": "https://bakeronline.be/uploads/banner/277/1300x315/slagerij-traiteur-frankel.png",
                        "width": 180,
                        "height": 180
                    }
                ]
            },
            "allow_comments": true,
            "allow_orders": true,
            "delivery_use_intervals": false
        },
        {
            "id": 277,
            "name": "The Dough Below",
            "active": true,
            "address": {
                "street": "Verschuerenweg",
                "nr": "31",
                "zipcode": "6880",
                "city": "Luik",
                "country": "BE",
                "position": {
                    "latitude": 51.05,
                    "longitude": 3.71667
                }
            },
            "avatar": {
                "resolutions": [
                    {
                        "src": "https://bakeronline.be/uploads/shop-avatars/277/180x180/bakkerij-van-hecke-iepenstraat.jpg",
                        "width": 178,
                        "height": 178
                    }
                ]
            },
            "banner": {
                "resolutions": [
                    {
                        "src": "https://bakeronline.be/uploads/banner/277/1300x315/slagerij-traiteur-frankel.png",
                        "width": 180,
                        "height": 180
                    }
                ]
            },
            "allow_comments": true,
            "allow_orders": true,
            "delivery_use_intervals": false
        },
        {
            "id": 277,
            "name": "The Dough Below",
            "active": true,
            "address": {
                "street": "Verschuerenweg",
                "nr": "31",
                "zipcode": "6880",
                "city": "Luik",
                "country": "BE",
                "position": {
                    "latitude": 51.05,
                    "longitude": 3.71667
                }
            },
            "avatar": {
                "resolutions": [
                    {
                        "src": "https://bakeronline.be/uploads/shop-avatars/277/180x180/bakkerij-van-hecke-iepenstraat.jpg",
                        "width": 178,
                        "height": 178
                    }
                ]
            },
            "banner": {
                "resolutions": [
                    {
                        "src": "https://bakeronline.be/uploads/banner/277/1300x315/slagerij-traiteur-frankel.png",
                        "width": 180,
                        "height": 180
                    }
                ]
            },
            "allow_comments": true,
            "allow_orders": true,
            "delivery_use_intervals": false
        }
    ],
    "id": 12,
    "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": {
            "nl": "string"
        },
        "description": {
            "nl": "string"
        },
        "url": {
            "nl": "string"
        }
    }
}
1.5.0 stable