README

Help shoppers choose the right product with guided selling flows on Magento category pages, product pages, and CMS content.

New to BerryPath? A free plan is available with 1 guided selling flow and up to 2,500 products. Existing customers keep using their current plan.

Guide shoppers where decisions happen

Category pages: narrow a large collection before filters and product grids become overwhelming.
Product pages: confirm whether the current product fits and guide shoppers to stronger alternatives.
CMS content: turn homepages, buying guides, landing pages, and campaigns into interactive product advice.
Popup, sidebar, or inline: choose the experience that best fits the page and storefront theme.

Built for Magento teams

Configure global market, locale, placement, and product identifier defaults per Magento scope.
Assign a different BerryPath Flow UUID to individual products and categories.
Place flows in CMS content with the Magento BerryPath Flow widget.
Match the current product by Magento product ID, SKU, or another product attribute.
Measure assisted order value from the Magento checkout success page.
Connect Magento product data with the included BerryPath Product Feed module.
Add Hyva storefront support with the optional compatibility package.

How it works

Build and publish a guided selling flow in BerryPath.
Copy its BerryPath Flow UUID or published widget URL.
Add it to a Magento category, product, or CMS widget.
Test the shopper journey and use BerryPath analytics to improve it.

A BerryPath account is required to build and publish guided selling flows.

Installation

composer require berrypath/magento2-berrypath-flow
bin/magento module:enable BerryPath_Flow
bin/magento setup:upgrade
bin/magento cache:flush

For local app/code development, place the module at:

app/code/BerryPath/Flow

The Composer package installs berrypath/magento2-berrypath-product-feed as a dependency.

Configuration

Store defaults:

Stores > Configuration > BerryPath > Flow

Configure the global enable switch, market code, locale, category and product placements, product ID source, and assisted conversion measurement here. Settings support Magento default, website, and store-view scope.

Place a flow:

Category: Catalog > Categories > BerryPath Flow
Product:  Catalog > Products > BerryPath Flow
CMS:      Content > Widgets > Add Widget > BerryPath Flow

Paste the public token, share URL, or embed URL from a published BerryPath flow. If no BerryPath Flow UUID is configured for the current placement, the module renders nothing.

The locale setting is sent as data-berrypath-locale. Leave it empty to derive the primary language from the Magento store locale—for example, de_DE becomes de.

Product feed

Manage product feeds from:

Catalog > BerryPath > Product Feeds

Create separate feeds for store views and channels, select the product attributes BerryPath needs for matching, and generate XML, CSV, or JSON output manually or through Magento cron.

See the berrypath/magento2-berrypath-product-feed package for detailed feed configuration.

Hyva compatibility

For Hyva storefronts, install the separate compatibility module:

composer require berrypath/magento2-berrypath-flow-hyva-compat
bin/magento module:enable BerryPath_FlowHyvaCompat
bin/magento setup:upgrade
bin/magento cache:flush

The package replaces the standard frontend templates through hyva-themes/magento2-compat-module-fallback while keeping the same placements and configuration.

External service and privacy

The module loads the BerryPath embed script only when a guided selling flow or assisted conversion event is used. BerryPath receives the configured flow token, locale, market code, and product identifier required to display and match the selected flow.

When assisted conversion measurement is enabled, the Magento checkout success page sends the order total and configured product identifiers to BerryPath. Customer names, email addresses, postal addresses, and payment details are not included. Measurement can be disabled in the module settings.