API Version 2
  • API V2 Overview
  • Category
    • Company
      • Customers
        • Orders
          • Pages
            • Page Templates
              • Products
                • Purchase Orders
                  • SKUs
                    • Support Tickets
                      • Tax Regions
                        • Vendors
                          • Warehouses
                            API Documentation

                            category/info

                            Type Info
                            List Categories or Subcategories
                            URL http://{domain}/api/v2/categories/info.json
                            Accepts Filters No
                            Output Attributes
                            Yes


                            List Categories Info Data

                            Gets Category or Subcategory info.
                            Filters
                            Filter the categories or subcategories into a list.
                            Parameter Type Rules Example
                            id int / array one id or multiple Lead Commerce category ids
                            1 or array(3,8,9,45)
                            subcategory
                            boolean
                            boolean value to display either categories or subcategories
                            true or false

                            Response

                            Example JSON returned
                            {
                              "code": "200",
                              "data": {
                                "1": [
                                  {
                                    "id": "1",
                                    "name": "Products",
                                    "display_name": "Products",
                                    "slug": "cat_products",
                                    "created": "1432246388",
                                    "updated": "1432246393",
                                    "default_subcategory_template": "3",
                                    "status": "1",
                                    "page_template": [
                                      {
                                        "id": "2",
                                        "name": "Category"
                                      }
                                    ],
                                    "attributes": ""
                                  }
                                ],
                                "2": [
                                  {
                                    "id": "2",
                                    "name": "Sale Items",
                                    "display_name": "Sale Items",
                                    "slug": "cat_sale_items",
                                    "created": "1432246394",
                                    "updated": "1432246394",
                                    "default_subcategory_template": "",
                                    "status": "1",
                                    "page_template": [
                                      {
                                        "id": "2",
                                        "name": "Category"
                                      }
                                    ],
                                    "attributes": ""
                                  }
                                ]
                              }
                            }
                            

                            Start your free, no-risk trial today.