Installation - Ultimate Cart Recovery (EN)

Tested against Magento Open Source 2.4.6 / 2.4.7 on PHP 8.2 / 8.3. Adobe Commerce is not supported in V1 (see ADDENDUM B3).

1. Install the module

composer require visicrea/module-ultimate-cart-recovery
bin/magento module:enable Visicrea_UltimateCartRecovery
bin/magento setup:upgrade
bin/magento setup:di:compile      # production mode only
bin/magento cache:flush

If you run a private package mirror, point Composer at it before requiring.

2. Configure the license

Visit Stores → Configuration → Visicrea → Ultimate Cart Recovery → License:

Field Value
License server URL https://license.ultimatecartrecovery.com/api/v1
License key the VCR-XXXX-XXXX-XXXX-XXXX you received by email

For development / staging instances:

bin/magento config:set visicrea_ucr/license/server_url mock://always-valid

The module also picks up the bundled mock client automatically when Magento runs in developer mode (no config needed).

3. Configure email sender + dry-run

In General:

4. Cron + queue consumers

The module ships seven cron jobs in etc/crontab.xml. Make sure your Magento cron is running:

bin/magento cron:status

For the message-queue consumers (sequences/use_message_queue=1 only):

bin/magento queue:consumers:start visicrea.ucr.cart.process
bin/magento queue:consumers:start visicrea.ucr.message.send
# ...etc

V1 ships with sequences/use_message_queue = 0 - the dispatch is synchronous inside the cron. Switch to async when sustained throughput tops ~1000 abandoned carts/day.

5. Run the setup wizard

Once enabled and the license is active, the Setup Wizard opens automatically on the next admin login. It walks through:

  1. License activation
  2. Store + branding defaults
  3. Email sender configuration
  4. Channel providers (Twilio / Brevo / Mailgun keys)
  5. Your first abandonment rule
  6. Cron status sanity check
  7. Test send to a chosen address
  8. Mark the module as ready

You can re-open the wizard at any time from Visicrea → Setup Wizard.

6. Verify

bin/magento ucr:debug:license             # confirms server check
bin/magento ucr:detect                    # forces one detection pass
bin/magento ucr:debug:cart {quote_id}     # inspects a single quote

You should see logs in var/log/visicrea_ucr.log after each invocation.

Next steps