ZRPL
  • Welcome!
  • Quick Start
  • Reference
    • API Reference
      • Categories List
      • Category Details by ID
      • Create Simple Product
      • Config Product Creation
      • Product List
      • Update Existing Product
      • Product Details by SKU
      • Product Details by ID
      • Products in Category
      • Create Order
      • Order Details
      • Order History
      • Create Customer
      • Customer Token
      • Create Customer Cart
      • Add Item to Cart
      • View Cart
      • Update Cart
      • Delete Cart
      • Country Code
      • Set Shipping and Billing
      • Place Order
      • Customer Details
Powered by GitBook
On this page
  1. Reference
  2. API Reference

Categories List

Retrieve a list of product categories with details like name, ID, parent ID, level, and subcategories for efficient management.

GET {{Base_url}}/rest/V1/categories

This endpoint retrieves a hierarchical list of product categories available in the system. The response includes details such as category ID, name, parent ID, active status, product count, level, and subcategories. It is useful for creating navigation menus or filtering products by categories.

Response Codes:

  • 200 OK: Categories retrieved successfully.

  • 401 Unauthorized: Invalid or missing authentication token.

  • 404 Not Found: The endpoint or resource does not exist.

Authentication:

Requires a valid Bearer token in the Authorization header.

curl --location '{{Base_url}}/rest/V1/categories' \
--header 'Authorization: Bearer eyJraWQiOiIxIiwiYWxnIjoiSFMyNTYifQ.eyJ1aWQiOjU1LCJ1dHlwaWQiOjIsImlhdCI6MTczNTI3NDUxNSwiZXhwIjoxNzM1Mjc4MTE1fQ.P084bprEnI-B8eEx8eAiH-dAh1skyYRWiigczTveAFc' \
--header 'Cookie: PHPSESSID=6t4unirh1unu87ef0stp2sv3kv; private_content_version=5ab80b7def0c212f723edead3c971a19'

Responses

{
    "id": 2,
    "parent_id": 89,
    "name": "Default",
    "image": null,
    "is_active": true,
    "position": 1,
    "level": 1,
    "product_count": 1365,
    "children_data": [
        {
            "id": 733,
            "parent_id": 2,
            "name": "Dyson",
            "image": "{{Base_url}}/media/catalog/category/Dyson_1_.png",
            "is_active": false,
            "position": 1,
            "level": 2,
            "product_count": 8,
            "children_data": []
        },
        {
            "id": 73,
            "parent_id": 2,
            "name": "Electronics",
            "image": "{{Base_url}}/media/catalog/category/Gift_Cards_1440_360_px__1_3_11.png",
            "is_active": true,
            "position": 2,
            "level": 2,
            "product_count": 408,
            "children_data":{
                    "id": 21,
                    "parent_id": 73,
                    "name": "Laptops",
                    "image": "{{Base_url}}/media/catalog/category/Gift_Cards_1440_360_px__1_3_12.png",
                    "is_active": true,
                    "position": 1,
                    "level": 3,
                    "product_count": 54,
                    "children_data": [
                    {
                            "id": 47,
                            "parent_id": 21,
                            "name": "HP",
                            "image": "{{Base_url}}/media/catalog/category/23316fd673a44931adf1e15c2839f757.w3000.h600._CR0_0_3000_600_SX1500_.jpg",
                            "is_active": true,
                            "position": 1,
                            "level": 4,
                            "product_count": 13,
                            "children_data": []
                        },
                        {
                            "id": 39,
                            "parent_id": 21,
                            "name": "Lenovo",
                            "image": "{{Base_url}}/media/catalog/category/Lenovo_banner.png",
                            "is_active": true,
                            "position": 2,
                            "level": 4,
                            "product_count": 40,
                            "children_data": []
                        }
                    ]
                },
                {
                    "id": 19,
                    "parent_id": 73,
                    "name": "Printers",
                    "image": "{{Base_url}}/media/catalog/category/HP_9_.png",
                    "is_active": false,
                    "position": 2,
                    "level": 3,
                    "product_count": 1,
                    "children_data": []
                },
                {
                    "id": 44,
                    "parent_id": 73,
                    "name": "PC Accessories",
                    "image": "{{Base_url}}/media/catalog/category/pc_accessories.png",
                    "is_active": true,
                    "position": 3,
                    "level": 3,
                    "product_count": 23,
                    "children_data": [
                    {
                            "id": 43,
                            "parent_id": 44,
                            "name": "Displays",
                            "image": null,
                            "is_active": false,
                            "position": 1,
                            "level": 4,
                            "product_count": 1,
                            "children_data": [
                                {
                                    "id": 85,
                                    "parent_id": 43,
                                    "name": "Dell",
                                    "image": null,
                                    "is_active": false,
                                    "position": 1,
                                    "level": 5,
                                    "product_count": 0,
                                    "children_data": []
                                },
                                {
                                    "id": 86,
                                    "parent_id": 43,
                                    "name": "Lenovo",
                                    "image": null,
                                    "is_active": false,
                                    "position": 2,
                                    "level": 5,
                                    "product_count": 5,
                                    "children_data": []
                                    }
                            ]
                        },
                        {
                            "id": 56,
                            "parent_id": 44,
                            "name": "Docking Stations",
                            "image": "{{Base_url}}/media/catalog/category/Dockers.png",
                            "is_active": true,
                            "position": 3,
                            "level": 4,
                            "product_count": 2,
                            "children_data": []
                        },
                        {
                            "id": 48,
                            "parent_id": 44,
                            "name": "External Hard Disk",
                            "image": null,
                            "is_active": false,
                            "position": 4,
                            "level": 4,
                            "product_count": 0,
                            "children_data": []
                        },
                        {
                            "id": 51,
                            "parent_id": 44,
                            "name": "Headset",
                            "image": null,
                            "is_active": false,
                            "position": 5,
                            "level": 4,
                            "product_count": 0,
                            "children_data": []
                        },
                        {
                            "id": 50,
                            "parent_id": 44,
                            "name": "Keyboard & Mouse",
                            "image": null,
                            "is_active": false,
                            "position": 6,
                            "level": 4,
                            "product_count": 3,
                            "children_data": [
                                {
                                    "id": 81,
                                    "parent_id": 50,
                                    "name": "Dell",
                                    "image": null,
                                    "is_active": false,
                                    "position": 1,
                                    "level": 5,
                                    "product_count": 0,
                                    "children_data": []
                                },
                                {
                                    "id": 82,
                                    "parent_id": 50,
                                    "name": "Lenovo",
                                    "image": null,
                                    "is_active": false,
                                    "position": 2,
                                    "level": 5,
                                    "product_count": 5,
                                    "children_data": []
                                }
                            ]
                        },
                        {
                            "id": 52,
                            "parent_id": 44,
                            "name": "Webcam",
                            "image": null,
                            "is_active": false,
                            "position": 7,
                            "level": 4,
                            "product_count": 2,
                            "children_data": []
                            },
                         {
            "id": 155,
            "parent_id": 2,
            "name": "The 60% Discount Store",
            "image": null,
            "is_active": false,
            "position": 3,
            "level": 2,
            "product_count": 2,
            "children_data": []
        },
        {
            "id": 7,
            "parent_id": 2,
            "name": "Gift Cards",
            "image": "{{Base_url}}/media/catalog/category/Gift_Cards_1440_360_px__1_7.png",
            "is_active": true,
            "position": 4,
            "level": 2,
            "product_count": 153,
            "children_data": [
                {
                    "id": 23,
                    "parent_id": 7,
                    "name": "E-commerce/Online",
                    "image": null,
                    "is_active": true,
                    "position": 1,
                    "level": 3,
                    "product_count": 16,
                    "children_data": []
                },
                {
                    "id": 26,
                    "parent_id": 7,
                    "name": "Food & Beverages",
                    "image": null,
                    "is_active": true,
                    "position": 4,
                    "level": 3,
                    "product_count": 12,
                    "children_data": []
                },
                {
                    "id": 521,
                    "parent_id": 7,
                    "name": "Infants & Children",
                    "image": null,
                    "is_active": true,
                    "position": 17,
                    "level": 3,
                    "product_count": 4,
                    "children_data": []
                },
                {
                    "id": 144,
                    "parent_id": 7,
                    "name": "Travel",
                    "image": null,
                    "is_active": true,
                    "position": 18,
                    "level": 3,
                    "product_count": 4,
                    "children_data": []
                },
                {
                    "id": 255,
                    "parent_id": 7,
                    "name": "Tinder Subscriptions",
                    "image": null,
                    "is_active": true,
                    "position": 19,
                    "level": 3,
                    "product_count": 3,
                    "children_data": []
                }
            ]
        },
        {
            "id": 37,
            "parent_id": 2,
            "name": "Two Wheelers",
            "image": "{{Base_url}}/media/catalog/category/tvs_27_.png",
            "is_active": false,
            "position": 5,
            "level": 2,
            "product_count": 26,
            "children_data": [
                {
                    "id": 70,
                    "parent_id": 37,
                    "name": "Bikes",
                    "image": null,
                    "is_active": true,
                    "position": 1,
                    "level": 3,
                    "product_count": 12,
                    "children_data": []
                },
                {
                    "id": 71,
                    "parent_id": 37,
                    "name": "Scooters",
                    "image": null,
                    "is_active": true,
                    "position": 2,
                    "level": 3,
                    "product_count": 14,
                    "children_data": []
                }
            ]
        },
        {
            "id": 46,
            "parent_id": 2,
            "name": "Home-Office Bundles",
            "image": null,
            "is_active": false,
            "position": 6,
            "level": 2,
            "product_count": 1,
            "children_data": []
        },
        {
            "id": 53,
            "parent_id": 2,
            "name": "Food & Beverages",
            "image": "{{Base_url}}/media/catalog/category/Gift_Cards_1440_360_px__1_3_13.png",
            "is_active": true,
            "position": 7,
            "level": 2,
            "product_count": 21,
            "children_data": [
                {
                    "id": 103,
                    "parent_id": 53,
                    "name": "Energy Drinks",
                    "image": null,
                    "is_active": true,
                    "position": 1,
                    "level": 3,
                    "product_count": 1,
                    "children_data": []
                },
                {
                    "id": 104,
                    "parent_id": 53,
                    "name": "Sanitizer",
                    "image": null,
                    "is_active": false,
                    "position": 6,
                    "level": 3,
                    "product_count": 9,
                    "children_data": [
                        {
                            "id": 109,
                            "parent_id": 104,
                            "name": "Gel",
                            "image": null,
                            "is_active": true,
                            "position": 1,
                            "level": 4,
                            "product_count": 5,
                            "children_data": []
                        },
                        {
                            "id": 110,
                            "parent_id": 104,
                            "name": "Liquid",
                            "image": null,
                            "is_active": true,
                            "position": 2,
                            "level": 4,
                            "product_count": 4,
                            "children_data": []
                        }
                    ]
                },
                {
                    "id": 145,
                    "parent_id": 53,
                    "name": "Chips",
                    "image": "{{Base_url}}/media/catalog/category/Chips_1440_x_360_px.png",
                    "is_active": true,
                    "position": 7,
                    "level": 3,
                    "product_count": 5,
                    "children_data": []
                },
                {
                    "id": 348,
                    "parent_id": 53,
                    "name": "Kitchen Staples",
                    "image": "{{Base_url}}/media/catalog/category/Kitchen_Staples_1440_x_360_px.png",
                    "is_active": false,
                    "position": 12,
                    "level": 3,
                    "product_count": 11,
                    "children_data": [
                        {
                            "id": 349,
                            "parent_id": 348,
                            "name": "Rice, Atta & Pulses",
                            "image": null,
                            "is_active": false,
                            "position": 1,
                            "level": 4,
                            "product_count": 11,
                            "children_data": []
                        }
                    ]
                },
                {
                    "id": 488,
                    "parent_id": 53,
                    "name": "Sweets & Dry Fruits ",
                    "image": null,
                    "is_active": false,
                    "position": 13,
                    "level": 3,
                    "product_count": 7,
                    "children_data": []
                },
                {
                    "id": 656,
                    "parent_id": 53,
                    "name": "Tea",
                    "image": "{{Base_url}}/media/catalog/category/IMG_5798.jpg",
                    "is_active": true,
                    "position": 14,
                    "level": 3,
                    "product_count": 8,
                    "children_data": []
                }
            ]
        },
        {
            "id": 38,
            "parent_id": 2,
            "name": "Mystery Box",
            "image": null,
            "is_active": false,
            "position": 8,
            "level": 2,
            "product_count": 1,
            "children_data": []
        },
        {
            "id": 29,
            "parent_id": 2,
            "name": "Waka Ware",
            "image": null,
            "is_active": false,
            "position": 15,
            "level": 2,
            "product_count": 0,
            "children_data": []
        },
        {
            "id": 33,
            "parent_id": 2,
            "name": "Exclusives",
            "image": null,
            "is_active": false,
            "position": 16,
            "level": 2,
            "product_count": 0,
            "children_data": [
                {
                    "id": 34,
                    "parent_id": 33,
                    "name": "Pen",
                    "image": null,
                    "is_active": false,
                    "position": 1,
                    "level": 3,
                    "product_count": 0,
                    "children_data": []
                },
                {
                    "id": 35,
                    "parent_id": 33,
                    "name": "Superbook Organizer",
                    "image": null,
                    "is_active": false,
                    "position": 2,
                    "level": 3,
                    "product_count": 0,
                    "children_data": []
                }
            ]
        },
        {
            "id": 74,
            "parent_id": 2,
            "name": "Hot Deals",
            "image": null,
            "is_active": false,
            "position": 17,
            "level": 2,
            "product_count": 2,
            "children_data": []
        },
        {
            "id": 114,
            "parent_id": 2,
            "name": "Personal Care & Grooming",
            "image": "{{Base_url}}/media/catalog/category/PC_Banner_V1_1.png",
            "is_active": true,
            "position": 18,
            "level": 2,
            "product_count": 201,
            "children_data": [
                {
                    "id": 376,
                    "parent_id": 114,
                    "name": "Hair Care",
                    "image": "{{Base_url}}/media/catalog/category/Haircare_Men_1.png",
                    "is_active": true,
                    "position": 4,
                    "level": 3,
                    "product_count": 31,
                    "children_data": [
                        {
                            "id": 682,
                            "parent_id": 376,
                            "name": "Philips",
                            "image": null,
                            "is_active": true,
                            "position": 1,
                            "level": 4,
                            "product_count": 9,
                            "children_data": []                    
                              }  
                    ]
                },
                {
                    "id": 379,
                    "parent_id": 114,
                    "name": "Skin Care",
                    "image": null,
                    "is_active": true,
                    "position": 5,
                    "level": 3,
                    "product_count": 56,
                    "children_data": [
                        {
                            "id": 380,
                            "parent_id": 379,
                            "name": "Mancode",
                            "image": "{{Base_url}}/media/catalog/category/Men_SkinCare.png",
                            "is_active": true,
                            "position": 1,
                            "level": 4,
                            "product_count": 23,
                            "children_data": []
                        },
                        {
                            "id": 381,
                            "parent_id": 379,
                            "name": "Women",
                            "image": null,
                            "is_active": false,
                            "position": 2,
                            "level": 4,
                            "product_count": 10,
                            "children_data": [
                                {
                                    "id": 405,
                                    "parent_id": 381,
                                    "name": "Mama Earth",
                                    "image": null,
                                    "is_active": false,
                                    "position": 1,
                                    "level": 5,
                                    "product_count": 10,
                                    "children_data": []
                                }
                            ]
                        },
                        {
                            "id": 663,
                            "parent_id": 379,
                            "name": "Avon",
                            "image": null,
                            "is_active": true,
                            "position": 3,
                            "level": 4,
                            "product_count": 6,
                            "children_data": []
                        },
                        {
                            "id": 688,
                            "parent_id": 379,
                            "name": "Machismo",
                            "image": "{{Base_url}}/media/catalog/category/skincare_rang.png",
                            "is_active": true,
                            "position": 5,
                            "level": 4,
                            "product_count": 8,
                            "children_data": []
                        }
                    ]
                },
                {
                    "id": 382,
                    "parent_id": 114,
                    "name": "Fragrances",
                    "image": null,
                    "is_active": true,
                    "position": 6,
                    "level": 3,
                    "product_count": 70,
                    "children_data": [
                        {
                            "id": 383,
                            "parent_id": 382,
                            "name": "LA' French",
                            "image": "{{Base_url}}/media/catalog/category/LA__French_Banner.png",
                            "is_active": true,
                            "position": 1,
                            "level": 4,
                            "product_count": 28,
                            "children_data": []
                        },
                        {
                            "id": 384,
                            "parent_id": 382,
                            "name": "A Fragrance Story",
                            "image": null,
                            "is_active": true,
                            "position": 2,
                            "level": 4,
                            "product_count": 23,
                            "children_data": []
                        },
                        {
                            "id": 393,
                            "parent_id": 382,
                            "name": "The man company ",
                            "image": null,
                            "is_active": false,
                            "position": 4,
                            "level": 4,
                            "product_count": 3,
                            "children_data": []
                        },
                        {
                            "id": 661,
                            "parent_id": 382,
                            "name": "Avon",
                            "image": null,
                            "is_active": true,
                            "position": 5,
                            "level": 4,
                            "product_count": 9,
                            "children_data": [
                                {
                                    "id": 659,
                                    "parent_id": 661,
                                    "name": "Body Spray",
                                    "image": null,
                                    "is_active": true,
                                    "position": 1,
                                    "level": 5,
                                    "product_count": 5,
                                    "children_data": []
                                },
                                {
                                    "id": 650,
                                    "parent_id": 661,
                                    "name": "Perfumes",
                                    "image": null,
                                    "is_active": true,
                                    "position": 2,
                                    "level": 5,
                                    "product_count": 4,
                                    "children_data": []
                        }
                    ]
                },
                {
                    "id": 632,
                    "parent_id": 114,
                    "name": "Fashion Accessories",
                    "image": null,
                    "is_active": true,
                    "position": 7,
                    "level": 3,
                    "product_count": 7,
                    "children_data": [
                        {
                            "id": 644,
                            "parent_id": 632,
                            "name": "Nail Enamel",
                            "image": null,
                            "is_active": true,
                            "position": 1,
                            "level": 4,
                            "product_count": 1,
                            "children_data": []
                        },
                        {
                            "id": 646,
                            "parent_id": 632,
                            "name": "Lipstick",
                            "image": null,
                            "is_active": false,
                            "position": 3,
                            "level": 4,
                            "product_count": 10,
                            "children_data": []
                        },
                        {
                            "id": 652,
                            "parent_id": 632,
                            "name": "Lip Balm",
                            "image": null,
                            "is_active": true,
                            "position": 8,
                            "level": 4,
                            "product_count": 3,
                            "children_data": []
                        }
                    ]
                },
                {
                    "id": 375,
                    "parent_id": 114,
                    "name": "Health Supplements",
                    "image": null,
                    "is_active": true,
                    "position": 8,
                    "level": 3,
                    "product_count": 9,
                    "children_data": []
                },
                {
                    "id": 451,
                    "parent_id": 114,
                    "name": "Oral Care",
                    "image": null,
                    "is_active": false,
                    "position": 9,
                    "level": 3,
                    "product_count": 49,
                    "children_data": []
                }
            ]
        },
        {
            "id": 115,
            "parent_id": 2,
            "name": "Home & Kitchen",
            "image": null,
            "is_active": true,
            "position": 19,
            "level": 2,
            "product_count": 23,
            "children_data": [
                {
                    "id": 116,
                    "parent_id": 115,
                    "name": "Air Freshener",
                    "image": null,
                    "is_active": false,
                    "position": 1,
                    "level": 3,
                    "product_count": 5,
                    "children_data": []
                },
                {
                    "id": 117,
                    "parent_id": 115,
                    "name": "Detergents",
                    "image": null,
                    "is_active": false,
                    "position": 2,
                    "level": 3,
                    "product_count": 7,
                    "children_data": [
                        {
                            "id": 118,
                            "parent_id": 117,
                            "name": "Ariel",
                            "image": null,
                            "is_active": true,
                            "position": 1,
                            "level": 4,
                            "product_count": 4,
                            "children_data": []
                        },
                        {
                            "id": 119,
                            "parent_id": 117,
                            "name": "Tide",
                            "image": null,
                            "is_active": true,
                            "position": 2,
                            "level": 4,
                            "product_count": 3,
                            "children_data": []
                        }
                    ]
                },
                {
                    "id": 57,
                    "parent_id": 115,
                    "name": "Fans & Purifiers",
                    "image": "{{Base_url}}/media/catalog/category/Fans_Purifiers_1440_x_360_px.png",
                    "is_active": true,
                    "position": 3,
                    "level": 3,
                    "product_count": 4,
                    "children_data": [
                        {
                            "id": 6,
                            "parent_id": 57,
                            "name": "Air Purifiers",
                            "image": "{{Base_url}}/media/catalog/category/Lasko_PURE.png",
                            "is_active": true,
                            "position": 1,
                            "level": 4,
                            "product_count": 2,
                            "children_data": [
                                {
                                    "id": 729,
                                    "parent_id": 6,
                                    "name": "Lasko",
                                    "image": null,
                                    "is_active": false,
                                    "position": 1,
                                    "level": 5,
                                    "product_count": 1,
                                    "children_data": []
                                },
                                {
                                    "id": 730,
                                    "parent_id": 6,
                                    "name": "Dyson",
                                    "image": "{{Base_url}}/media/catalog/category/Air_purifier_-1.png",
                                    "is_active": false,
                                    "position": 2,
                                    "level": 5,
                                    "product_count": 4,
                                    "children_data": [] 
                        },
                        {
                            "id": 42,
                            "parent_id": 57,
                            "name": "Tower Fans",
                            "image": "{{Base_url}}/media/catalog/category/Lasko_Tower_Fan.png",
                            "is_active": true,
                            "position": 2,
                            "level": 4,
                            "product_count": 1,
                            "children_data": []
                        },
                        {
                            "id": 158,
                            "parent_id": 57,
                            "name": "Fanzart Fans",
                            "image": "{{Base_url}}/media/catalog/category/Fanzart_Fans_1.png",
                            "is_active": false,
                            "position": 3,
                            "level": 4,
                            "product_count": 29,
                            "children_data": []
                        }
                    ]
                },
              {
                    "id": 111,
                    "parent_id": 115,
                    "name": "Grills & Lighters",
                    "image": null,
                    "is_active": false,
                    "position": 5,
                    "level": 3,
                    "product_count": 3,
                    "children_data": [
                        {
                            "id": 125,
                            "parent_id": 111,
                            "name": "Charcoal/Electric Grills",
                            "image": "{{Base_url}}/media/catalog/category/weber.png",
                            "is_active": false,
                            "position": 1,
                            "level": 4,
                            "product_count": 8,
                            "children_data": []
                        },
                        {
                            "id": 112,
                            "parent_id": 111,
                            "name": "Lighters (Zippo)",
                            "image": "{{Base_url}}/media/catalog/category/zippo.png",
                            "is_active": false,
                            "position": 2,
                            "level": 4,
                            "product_count": 7,
                            "children_data": []
                        },
                        {
                            "id": 113,
                            "parent_id": 111,
                            "name": "Fire Starters",
                            "image": null,
                            "is_active": false,
                            "position": 3,
                            "level": 4,
                            "product_count": 3,
                            "children_data": []
                        }
                    ]
                },
                {
                    "id": 238,
                    "parent_id": 115,
                    "name": "Safety & Security",
                    "image": "{{Base_url}}/media/catalog/category/Safeguarding_1440_x_360_px.png",
                    "is_active": false,
                    "position": 6,
                    "level": 3,
                    "product_count": 2,
                    "children_data": []
                },
                {
                    "id": 288,
                    "parent_id": 115,
                    "name": "Samsung",
                    "image": null,
                    "is_active": false,
                    "position": 7,
                    "level": 3,
                    "product_count": 6,
                    "children_data": []
                },
                {
                    "id": 455,
                    "parent_id": 115,
                    "name": "Refrigerator",
                    "image": null,
                    "is_active": false,
                    "position": 8,
                    "level": 3,
                    "product_count": 1,
                    "children_data": [
                        {
                            "id": 616,
                            "parent_id": 455,
                            "name": "Panasonic",
                            "image": null,
                            "is_active": false,
                            "position": 1,
                            "level": 4,
                            "product_count": 1,
                            "children_data": []
                        }
                    ]
                },
                {
                    "id": 456,
                    "parent_id": 115,
                    "name": "Television",
                    "image": null,
                    "is_active": false,
                    "position": 9,
                    "level": 3,
                    "product_count": 1,
                    "children_data": [
                        {
                            "id": 460,
                            "parent_id": 456,
                            "name": "Sony",
                            "image": null,
                            "is_active": false,
                            "position": 1,
                            "level": 4,
                            "product_count": 0,
                            "children_data": []
                        },
                        {
                            "id": 461,
                            "parent_id": 456,
                            "name": "Samsung",
                            "image": null,
                            "is_active": false,
                            "position": 2,
                            "level": 4,
                            "product_count": 0,
                            "children_data": []
                        }
                    ]
                },
                {
                    "id": 457,
                    "parent_id": 115,
                    "name": "Microwave Oven",
                    "image": null,
                    "is_active": false,
                    "position": 10,
                    "level": 3,
                    "product_count": 7,
                    "children_data": []
                },
                {
                    "id": 458,
                    "parent_id": 115,
                    "name": "Washing Machine",
                    "image": null,
                    "is_active": false,
                    "position": 11,
                    "level": 3,
                    "product_count": 1,
                    "children_data": []
                },
                {
                    "id": 711,
                    "parent_id": 115,
                    "name": "Home Appliances ",
                    "image": null,
                    "is_active": true,
                    "position": 15,
                    "level": 3,
                    "product_count": 9,
                    "children_data": [
                        {
                            "id": 712,
                            "parent_id": 711,
                            "name": "Samsung",
                            "image": null,
                            "is_active": true,
                            "position": 1,
                            "level": 4,
                            "product_count": 0,
                            "children_data": []
                        },
                        {
                            "id": 782,
                            "parent_id": 711,
                            "name": "Milton",
                            "image": null,
                            "is_active": true,
                            "position": 2,
                            "level": 4,
                            "product_count": 5,
                            "children_data": []
                        },
                        {
                            "id": 799,
                            "parent_id": 711,
                            "name": "Bajaj",
                            "image": null,
                            "is_active": true,
                            "position": 6,
                            "level": 4,
                            "product_count": 7,
                            "children_data": []
                        },
                        {
                            "id": 800,
                            "parent_id": 711,
                            "name": "Wonderchef",
                            "image": null,
                            "is_active": true,
                            "position": 7,
                            "level": 4,
                            "product_count": 5,
                            "children_data": []
                        },
                        {
                            "id": 801,
                            "parent_id": 711,
                            "name": "Prestige",
                            "image": null,
                            "is_active": true,
                            "position": 8,
                            "level": 4,
                            "product_count": 1,
                            "children_data": [         
                }
            ]
        },
        {
            "id": 131,
            "parent_id": 2,
            "name": "G.I. Store",
            "image": null,
            "is_active": false,
            "position": 20,
            "level": 2,
            "product_count": 5,
            "children_data": [
                {
                    "id": 132,
                    "parent_id": 131,
                    "name": "Tea",
                    "image": null,
                    "is_active": true,
                    "position": 1,
                    "level": 3,
                    "product_count": 0,
                    "children_data": []
                },
                {
                    "id": 133,
                    "parent_id": 131,
                    "name": "Coffee",
                    "image": null,
                    "is_active": true,
                    "position": 2,
                    "level": 3,
                    "product_count": 2,
                    "children_data": []
                },
                {
                    "id": 134,
                    "parent_id": 131,
                    "name": "Rice",
                    "image": null,
                    "is_active": true,
                    "position": 3,
                    "level": 3,
                    "product_count": 3,
                    "children_data": []
                },
                {
                    "id": 135,
                    "parent_id": 131,
                    "name": "Spices",
                    "image": null,
                    "is_active": true,
                    "position": 4,
                    "level": 3,
                    "product_count": 0,
                    "children_data": []
                }
            ]
        },
        {
            "id": 150,
            "parent_id": 2,
            "name": "Amazon Kindle",
            "image": null,
            "is_active": false,
            "position": 21,
            "level": 2,
            "product_count": 1,
            "children_data": []
        },
        {
            "id": 154,
            "parent_id": 2,
            "name": "Apple Store",
            "image": null,
            "is_active": false,
            "position": 22,
            "level": 2,
            "product_count": 2,
            "children_data": []
        },
        {
            "id": 156,
            "parent_id": 2,
            "name": "Fanzart",
            "image": "{{Base_url}}/media/catalog/category/Fanzart_Fans.png",
            "is_active": false,
            "position": 23,
            "level": 2,
            "product_count": 211,
            "children_data": []
        },
        {
            "id": 157,
            "parent_id": 2,
            "name": "Activities",
            "image": "{{Base_url}}/media/catalog/category/imagicaa_category_banner_1__1.png",
            "is_active": false,
            "position": 24,
            "level": 2,
            "product_count": 6,
            "children_data": [
                {
                    "id": 261,
                    "parent_id": 157,
                    "name": "Theme Park",
                    "image": null,
                    "is_active": false,
                    "position": 1,
                    "level": 3,
                    "product_count": 3,
                    "children_data": []
                },
                {
                    "id": 262,
                    "parent_id": 157,
                    "name": "Water Park",
                    "image": null,
                    "is_active": false,
                    "position": 2,
                    "level": 3,
                    "product_count": 3,
                    "children_data": []
                }
            ]
        },
        {
            "id": 161,
            "parent_id": 2,
            "name": "Euronet",
            "image": null,
            "is_active": false,
            "position": 25,
            "level": 2,
            "product_count": 3,
            "children_data": []
        },
        {
            "id": 182,
            "parent_id": 2,
            "name": "Shopify Products",
            "image": null,
            "is_active": false,
            "position": 26,
            "level": 2,
            "product_count": 6,
            "children_data": []
        },
        {
            "id": 184,
            "parent_id": 2,
            "name": "Fireboltt Products",
            "image": null,
            "is_active": false,
            "position": 27,
            "level": 2,
            "product_count": 31,
            "children_data": []
        },
        {
            "id": 185,
            "parent_id": 2,
            "name": "Renaura Products",
            "image": null,
            "is_active": false,
            "position": 28,
            "level": 2,
            "product_count": 21,
            "children_data": [
                {
                    "id": 191,
                    "parent_id": 185,
                    "name": "Personal Care & Grooming",
                    "image": null,
                    "is_active": true,
                    "position": 1,
                    "level": 3,
                    "product_count": 12,
                    "children_data": [
                        {
                            "id": 192,
                            "parent_id": 191,
                            "name": "Hair Care",
                            "image": null,
                            "is_active": false,
                            "position": 1,
                            "level": 4,
                            "product_count": 11,
                            "children_data": [
                                {
                                    "id": 193,
                                    "parent_id": 192,
                                    "name": "iluvia",
                                    "image": null,
                                    "is_active": true,
                                    "position": 1,
                                    "level": 5,
                                    "product_count": 11,
                                    "children_data": []
                                }
                            ]
                        },  
                        {
            "id": 194,
            "parent_id": 2,
            "name": "Aguante Products",
            "image": null,
            "is_active": false,
            "position": 29,
            "level": 2,
            "product_count": 4,
            "children_data": [
                {
                    "id": 406,
                    "parent_id": 194,
                    "name": "Capri",
                    "image": null,
                    "is_active": false,
                    "position": 1,
                    "level": 3,
                    "product_count": 0,
                    "children_data": []
                }
            ]
        },
        {
            "id": 231,
            "parent_id": 2,
            "name": "Fragrancestory Products",
            "image": "{{Base_url}}/media/catalog/category/fragrance_category_banner.png",
            "is_active": true,
            "position": 30,
            "level": 2,
            "product_count": 32,
            "children_data": []
        },
        {
            "id": 237,
            "parent_id": 2,
            "name": "ZEPP Coins",
            "image": null,
            "is_active": false,
            "position": 31,
            "level": 2,
            "product_count": 1,
            "children_data": []
        },
        {
            "id": 240,
            "parent_id": 2,
            "name": "Tempt Products",
            "image": null,
            "is_active": false,
            "position": 32,
            "level": 2,
            "product_count": 56,
            "children_data": []
        },
        {
            "id": 260,
            "parent_id": 2,
            "name": "Tagz Products",
            "image": null,
            "is_active": false,
            "position": 33,
            "level": 2,
            "product_count": 5,
            "children_data": []
        },
        {
            "id": 268,
            "parent_id": 2,
            "name": "Insurance",
            "image": "{{Base_url}}/media/catalog/category/Insurance_Banners_2__1.png",
            "is_active": true,
            "position": 34,
            "level": 2,
            "product_count": 5,
            "children_data": [
                {
                    "id": 269,
                    "parent_id": 268,
                    "name": "Personal Accident Insurance",
                    "image": null,
                    "is_active": true,
                    "position": 1,
                    "level": 3,
                    "product_count": 1,
                    "children_data": []
                },
                {
                    "id": 655,
                    "parent_id": 268,
                    "name": "Home Appliances Protection",
                    "image": null,
                    "is_active": true,
                    "position": 5,
                    "level": 3,
                    "product_count": 1,
                    "children_data": []
                },
                {
                    "id": 654,
                    "parent_id": 268,
                    "name": "Financial Protection",
                    "image": null,
                    "is_active": true,
                    "position": 6,
                    "level": 3,
                    "product_count": 2,
                    "children_data": []
                }
            ]
        },
        {
            "id": 279,
            "parent_id": 2,
            "name": "Loveluckfoods Products",
            "image": null,
            "is_active": false,
            "position": 35,
            "level": 2,
            "product_count": 0,
            "children_data": []
        },
        {
            "id": 330,
            "parent_id": 2,
            "name": "₹99 Store",
            "image": "{{Base_url}}/media/catalog/category/99STORE_Category_Banners_1440_360_px__1.png",
            "is_active": true,
            "position": 36,
            "level": 2,
            "product_count": 18,
            "children_data": []
        },
        {
            "id": 498,
            "parent_id": 2,
            "name": "Festive Hampers",
            "image": "{{Base_url}}/media/catalog/category/Festive_hampers_category.jpg",
            "is_active": true,
            "position": 44,
            "level": 2,
            "product_count": 26,
            "children_data": [
                {
                    "id": 499,
                    "parent_id": 498,
                    "name": "The Baklava Box",
                    "image": "{{Base_url}}/media/catalog/category/Baklava_Box_category_banner.png",
                    "is_active": true,
                    "position": 1,
                    "level": 3,
                    "product_count": 16,
                    "children_data": []
                },
                {
                    "id": 496,
                    "parent_id": 498,
                    "name": "Cookieman",
                    "image": "{{Base_url}}/media/catalog/category/Untitled_design_52_.png",
                    "is_active": true,
                    "position": 3,
                    "level": 3,
                    "product_count": 9,
                    "children_data": []
                }
            ]
        }

Top-Level Attributes

  1. id

    • Definition: A unique identifier for the category.

    • Example: "id": 2

      • The category Default is identified with the unique ID 2.

  2. parent_id

    • Definition: The ID of the parent category.

    • Example: "parent_id": 89

      • The parent category of Default is identified with the ID 89.

  3. name

    • Definition: The name of the category, displayed in the application.

    • Example: "name": "Default"

      • The name Default will appear as a category name to users.

  4. image

    • Definition: URL for the category's image, used for visual representation.

    • Example: "image": null

      • No image is assigned to the Default category since the value is null.

  5. is_active

    • Definition: Indicates whether the category is active (true) or inactive (false).

    • Example: "is_active": true

      • The Default category is active and visible in the application.

  6. position

    • Definition: Position of the category among its siblings within the same parent.

    • Example: "position": 1

      • The Default category appears first under its parent.

  7. level

    • Definition: The hierarchy level of the category in the catalog structure.

    • Example: "level": 1

      • The Default category is at the first (topmost) level.

  8. product_count

    • Definition: The number of products available in this category.

    • Example: "product_count": 1366

      • The Default category contains a total of 1366 products.

  9. children_data

    • Definition: An array of subcategories (child categories) under this category.

    • Contains details about subcategories like Dyson and Electronics.

Attributes in children_data

Each child object in children_data has the same attributes as the parent category, with specific values:

Example 1: Dyson

  1. id: "id": 733

    • Unique ID for the Dyson category.

  2. parent_id: "parent_id": 2

    • Parent ID 2 indicates Dyson is a child of the Default category.

  3. name: "name": "Dyson"

    • The category name is Dyson.

  4. image: "image": "{{Base_url}}/media/catalog/category/Dyson_1_.png"

    • URL for the Dyson category's image.

  5. is_active: "is_active": false

    • The Dyson category is inactive and will not appear in the application.

  6. position: "position": 1

    • Dyson appears first under Default.

  7. level: "level": 2

    • Dyson is a second-level category.

  8. product_count: "product_count": 8

    • There are 8 products in the Dyson category.

  9. children_data: "children_data": []

    • No subcategories under Dyson.


Example 2: Electronics

The Electronics category contains more subcategories:

  1. id: "id": 73

    • Unique ID for Electronics.

  2. parent_id: "parent_id": 2

    • Parent ID 2 indicates Electronics is a child of Default.

  3. name: "name": "Electronics"

    • The category name is Electronics.

  4. image: "image": "{{Base_url}}/media/catalog/category/Gift_Cards_1440_360_px__1_3_11.png"

    • URL for the Electronics category's image.

  5. is_active: "is_active": true

    • The Electronics category is active and visible.

  6. position: "position": 2

    • Electronics appears second under Default.

  7. level: "level": 2

    • Electronics is a second-level category.

  8. product_count: "product_count": 408

    • There are 408 products in the Electronics category.

  9. children_data: Contains subcategories like Laptops.

{
    "message": "Request does not match any route."
}
{
    "message": "The consumer isn't authorized to access %resources.",
    "parameters": {
        "resources": "Magento_Catalog::categories"
    }
}
PreviousAPI ReferenceNextCategory Details by ID

Last updated 4 months ago