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”.
GET /api/v1/catalogue/collections
List collections, optionally filtered by free-text search.
Query parameters
| Param | Description |
|---|---|
search | Free-text query. |
limit | Page size. |
location_id | Optional location scope. |
curl "https://api.cimplify.io/api/v1/catalogue/collections?limit=20" \
-H "X-Public-Key: pk_test_your_publishable_key"Response
{
"success": true,
"data": [
{
"id": "col_holiday",
"name": "Holiday picks",
"slug": "holiday-picks",
"image_url": "https://cdn.cimplify.io/col/holiday.jpg",
"product_count": 12
}
]
}GET /api/v1/catalogue/collections/{collection_id}
Single collection detail with attached metadata.
curl https://api.cimplify.io/api/v1/catalogue/collections/col_holiday \
-H "X-Public-Key: pk_test_your_publishable_key"GET /api/v1/catalogue/collections/{collection_id}/products
Products that belong to a collection, paginated by page / limit / offset.
curl "https://api.cimplify.io/api/v1/catalogue/collections/col_holiday/products?limit=12" \
-H "X-Public-Key: pk_test_your_publishable_key"GET /api/v1/catalogue/collections/{collection_id}/attributes
Attribute definitions configured for a collection.
curl https://api.cimplify.io/api/v1/catalogue/collections/col_holiday/attributes \
-H "X-Public-Key: pk_test_your_publishable_key"GET /api/v1/catalogue/collections/{collection_id}/deals
Active deals targeting a collection.
curl https://api.cimplify.io/api/v1/catalogue/collections/col_holiday/deals \
-H "X-Public-Key: pk_test_your_publishable_key"-
Categories Hierarchical groupings tied to navigation.
-
Bundles Fixed product combinations sold as one SKU.
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`.
Bundles
Bundles combine multiple products into a single purchasable unit at a fixed price: meal deals, gift sets, starter packs. Each `component` can require a specific quantity and optionally lock to a specific variant.