cimplify
API referenceCatalogue

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.

GET /api/v1/catalogue/bundles

List bundles. Supports search and limit.

cURL
curl "https://api.cimplify.io/api/v1/catalogue/bundles?limit=20" \
  -H "X-Public-Key: pk_test_your_publishable_key"

Response

{
  "success": true,
  "data": [
    {
      "id": "bun_breakfast",
      "name": "Breakfast deal",
      "slug": "breakfast-deal",
      "default_price": "12.50",
      "currency": "GHS",
      "image_url": "https://cdn.cimplify.io/bun/breakfast.jpg"
    }
  ]
}

GET /api/v1/catalogue/bundles/{bundle_id}

Bundle detail with the full component list. Each component points at a product (or specific variant) and a required quantity.

Request

cURL
curl https://api.cimplify.io/api/v1/catalogue/bundles/bun_breakfast \
  -H "X-Public-Key: pk_test_your_publishable_key"

Response

{
  "success": true,
  "data": {
    "id": "bun_breakfast",
    "name": "Breakfast deal",
    "default_price": "12.50",
    "currency": "GHS",
    "components": [
      {
        "component_id": "bcomp_drink",
        "name": "Drink",
        "product_id": "prod_coffee",
        "default_variant_id": "var_regular",
        "quantity": 1,
        "is_swappable": true
      },
      {
        "component_id": "bcomp_food",
        "name": "Pastry",
        "product_id": "prod_croissant",
        "quantity": 1,
        "is_swappable": false
      }
    ]
  }
}

Adding a bundle to cart

Bundles flow through POST /cart/items. Pass item_id as the bundle’s product id, then provide bundle_selections for any swappable components.

cURL
curl -X POST https://api.cimplify.io/api/v1/cart/items \
  -H "X-Public-Key: pk_test_your_publishable_key" \
  -H "Content-Type: application/json" \
  -d '{
    "item_id": "prod_breakfast_bundle",
    "quantity": 1,
    "bundle_selections": [
      { "component_id": "bcomp_drink", "variant_id": "var_double", "quantity": 1 }
    ]
  }'
  • Composites Build-your-own products with priced component groups.

  • Cart Pass bundle_selections when adding a bundle.

On this page