GET
/
catalog
/
categories
curl --request GET \
  --url https://services.commercengine.dev/api/v1/x2yh61zw4k/admin/catalog/categories \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "success": true,
  "content": {
    "categories": [
      {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "active": true,
        "parent_category_id": "<string>",
        "auto_assign_products": true,
        "assign_products_condition": {},
        "product_count": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "child_categories": [
          {
            "id": "<string>",
            "name": "<string>",
            "description": "<string>",
            "active": true,
            "parent_category_id": "<string>",
            "auto_assign_products": true,
            "assign_products_condition": {},
            "product_count": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z"
          }
        ]
      }
    ],
    "pagination": {
      "total_records": 123,
      "total_pages": 123,
      "previous_page": "<any>",
      "limit": 123,
      "next_page": "<any>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
parent_category_id
string

to return child categories

​
category_name
string

use to check duplicity

​
nested_level
integer

to return categories upto specified nested level

​
page
integer

page number of pagination list

Required range: x > 1
​
limit
integer

no of rows per page

Required range: x > 1
​
sort_by
string

JSON string format: {"field1":"asc", "field2":"desc"}

​
search
string

search keyword

​
filters
string

JSON - array of objects

Response

200 - application/json
OK
​
message
string
​
success
boolean
​
content
object
Retrieve variant detailRetrieve product reviews