Categories
Categories group products into the navigation tree shoppers see in menus and storefront sidebars. They are flat at the API level; nesting is expressed via `parent_id`.
GET /api/v1/catalogue/categories
List all categories for the active business.
Request
curl https://api.cimplify.io/api/v1/catalogue/categories \
-H "X-Public-Key: pk_test_your_publishable_key"Response
{
"success": true,
"data": [
{
"id": "cat_drinks",
"name": "Drinks",
"slug": "drinks",
"parent_id": null,
"image_url": "https://cdn.cimplify.io/c/drinks.jpg",
"product_count": 24,
"sort_order": 1
}
]
}GET /api/v1/catalogue/categories/{category_id}
Detail for a single category.
curl https://api.cimplify.io/api/v1/catalogue/categories/cat_drinks \
-H "X-Public-Key: pk_test_your_publishable_key"GET /api/v1/catalogue/categories/{category_id}/products
Products in a category with paging via limit and offset.
curl "https://api.cimplify.io/api/v1/catalogue/categories/cat_drinks/products?limit=20&offset=0" \
-H "X-Public-Key: pk_test_your_publishable_key"GET /api/v1/catalogue/categories/{category_id}/attributes
Attribute definitions configured for a category, useful for rendering filter facets.
curl https://api.cimplify.io/api/v1/catalogue/categories/cat_drinks/attributes \
-H "X-Public-Key: pk_test_your_publishable_key"GET /api/v1/catalogue/categories/{category_id}/deals
Active deals scoped to a category.
curl https://api.cimplify.io/api/v1/catalogue/categories/cat_drinks/deals \
-H "X-Public-Key: pk_test_your_publishable_key"Category object
| Field | Type | Description |
|---|---|---|
id | string | Category identifier. |
name | string | Display name. |
slug | string | URL-friendly identifier. |
parent_id | string | null | Parent category, if nested. |
product_count | int | Number of active products in the category. |
sort_order | int | Display order; ascending. |
-
Products Filter the products list by
category_idorcategory_slug. -
Collections Curated cross-category groupings.
Variants
Variants are options on a product (size, colour, duration, etc.). They are returned inline on the product detail endpoint, but there are also dedicated endpoints to list variants, look up a single variant by ID, and resolve a variant from a set of axis selections.
Collections
Collections are curated, often-time-bound groupings of products that don’t fit a single category, e.g. “Holiday gifts”, “Staff picks”, “Featured this week”.