Collections

Curated product groupings for merchandising (e.g., "Best Sellers", "Summer Sale").

GET/api/v1/catalogue/collections

List Collections

Example Request

curl

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

Example Response

JSON

{
  "success": true,
  "data": [
    {
      "id": "col_bestsellers",
      "name": "Best Sellers",
      "description": "Our most popular items",
      "image_url": "https://cdn.example.com/bestsellers.jpg",
      "product_count": 15
    },
    {
      "id": "col_new",
      "name": "New Arrivals",
      "description": "Just added to the menu",
      "image_url": null,
      "product_count": 6
    }
  ]
}

GET/api/v1/catalogue/collections/{id}

Get Collection

Returns the collection with its full list of products.

Example Response

JSON

{
  "success": true,
  "data": {
    "id": "col_bestsellers",
    "name": "Best Sellers",
    "description": "Our most popular items",
    "image_url": "https://cdn.example.com/bestsellers.jpg",
    "products": [
      {
        "id": "prod_abc123",
        "name": "Espresso",
        "slug": "espresso",
        "default_price": "4.50",
        "image_url": "https://cdn.example.com/espresso.jpg",
        "product_type": "product"
      }
    ]
  }
}

Collection Object

Field	Type	Description
`id`	string	Unique collection identifier
`name`	string	Collection name
`description`	string \| null	Collection description
`image_url`	string \| null	Banner image
`product_count`	integer	Number of products (list endpoint)
`products`	array	Product objects (detail endpoint)