You are viewing an older version of the Abandoned Cart documentation (4.x). View the latest version (5.x) →
Get Started

Configuration

You can customise Abandoned Cart’s settings using a PHP configuration file. This is optional: each setting has a default, so you only need to include the values you want to change.

To override a setting, create abandoned-cart.php in your Craft project’s /config directory and return an array of setting names and values. For example, the following will change the name displayed in the control panel:

<?php

return [
    'pluginName' => 'Abandoned Cart Tools',
];

All other settings keep their defaults. Add any further settings you want to change to the same array. The options below explain the available settings and their defaults. You can also manage these settings in the control panel under Abandoned Carts → Settings.

Configuration Options

pluginName

The name displayed for the plugin in the control panel.

passKey

A generated bearer credential for the optional HTTP scheduler endpoint. Send it only in the Authorization header; the console scheduler does not use it. A unique key is generated when this value is empty.

restoreExpiryHours

How many hours should abandoned cart restore links last for after being sent.

firstReminderDelay

How many hours after a cart has been abandoned should the 1st reminder be sent.

secondReminderDelay

How many hours after a cart has been abandoned should the 2nd reminder be sent.

recipientCooldownHours

How many hours a recipient must wait before another reminder sequence can be created. Recipient matching ignores surrounding whitespace and letter case, and an unfinished sequence always remains exclusive.

maxEnrollmentsPerRun

The maximum number of new reminder sequences that can be created each time abandoned carts are processed.

staleRecordRetentionDays

How many days inactive abandoned cart records should be retained. Cleanup never shortens configured reminder delays or restore-link expiry.

discountCode

Enter the discount code that abandoned carts can use.

firstReminderTemplate

Use a custom template for the 1st reminder email.

secondReminderTemplate

Use a custom template for the 2nd reminder email.

firstReminderSubject

The subject for the 1st reminder email.

secondReminderSubject

The subject for the 2nd reminder email.

recoveryUrl

By default recovered carts will be redirected to shop/cart, use this field if you use something different.

disableSecondReminder

Whether to disable the second reminder email. Set this to true to send only the first reminder.

blacklist

Enter emails or domains separated by a comma that should be ignored.

includeBlacklisted

Whether blacklisted carts should be included in the Dashboard.