README

AI-powered site search widget for Magento 2, powered by Koply.

Why Koply

• AI included, no add-ons — zero-results recovery, automatic synonym suggestions and catalog enrichment are included in every plan, not sold separately like Doofinder or Algolia
• EU-hosted — all data processed and stored in Sweden. GDPR-compliant by design, no cookie consent required for the widget
• Unlimited searches — fixed price per site, no per-query billing, no surprises on your invoice
• 2-minute setup — install the module, add your API key, done. All widget customization (colors, locale, placeholder) is managed from the Koply panel

Requirements

• Magento 2.4.x
• PHP 8.1+

Installation

Via Composer (recommended)

composer require koply/magento2-search
php bin/magento module:enable Koply_Search
php bin/magento setup:upgrade
php bin/magento cache:clean

Manual installation

1. Download the module ZIP
2. Extract to app/code/Koply/Search/
3. Run:

php bin/magento module:enable Koply_Search
php bin/magento setup:upgrade
php bin/magento cache:clean

Configuration

1. Go to Stores > Configuration > Koply > Search Widget
2. Set Enable to Yes
3. Enter your API Key — found in your Koply panel under Sites > Embed
4. Save and flush cache

Your API key is site-specific. If you manage multiple Magento stores, create one site per store in the Koply panel and use each site's API key independently.

How it works

The module injects the Koply widget script before </body> on all frontend pages. It also registers a koply.cart.add event listener that handles add-to-cart requests using Magento 2's native /checkout/cart/add/ endpoint.

All search customization — colors, placeholder text, locale, boosting rules, synonyms — is configured from your Koply panel. No Magento deployments needed for search changes.

Events

koply.cart.add

Fired by the Koply widget when a user clicks "Add to cart".

{
    entity_id: "595",   // Magento product entity_id
    qty: 1
}

koply.cart.added

Fired after a successful add-to-cart request.

Pricing

Plans start at €0 (Free) with unlimited searches on all paid plans. See full pricing at koply.eu/pricing.

All paid plans include a 14-day free trial. No credit card required.

Support

• Documentation: koply.eu/docs
• Email: support@koply.eu
• Website: koply.eu