cimplify

Categories

List product categories for storefront navigation and filtering.

GET/api/v1/catalogue/categories

List Categories

Example Request

curl
curl https://storefront.cimplify.io/api/v1/catalogue/categories \
  -H "X-API-Key: pk_test_your_api_key"

Example Response

JSON
{
  "success": true,
  "data": [
    {
      "id": "cat_1",
      "name": "Coffee",
      "slug": "coffee",
      "description": "Hot and cold coffee drinks",
      "image_url": "https://cdn.example.com/coffee.jpg",
      "parent_id": null,
      "display_order": 1,
      "product_count": 12
    },
    {
      "id": "cat_2",
      "name": "Pastries",
      "slug": "pastries",
      "description": "Fresh baked goods",
      "image_url": "https://cdn.example.com/pastries.jpg",
      "parent_id": null,
      "display_order": 2,
      "product_count": 8
    }
  ]
}

Category Object

FieldTypeDescription
idstringUnique category identifier
namestringCategory name
slugstringURL-friendly identifier
descriptionstring | nullCategory description
image_urlstring | nullCategory image
parent_idstring | nullParent category ID for nesting
display_orderintegerSort order
product_countintegerNumber of active products