Installation

Overview · Configuration · Usage · Developer notes · FAQ

Requirements

• CS-Cart or CS-Cart Multi-Vendor 4.17.2 – 4.21.x, PHP 7.2.5 – 8.3.
• The core add-on Product reviews (recommended) or Comments and reviews must be active, so that customers can leave reviews.
• Working outgoing e-mail (Settings → E-mails). Review requests use the store’s own mail settings and e-mail layout.
• A cron job is recommended (see below).

Install

1. In the admin panel go to Add-ons → Manage add-ons, click the + (Upload & install add-on) button and upload kv_review_request_emails-1.0.0.zip.
2. The add-on is installed and switched on. Open its settings: Add-ons → Manage add-ons → Automated Review Requests → Settings.
3. Enter your license key on the License tab (see License). Without a key the add-on works for 14 days.
4. Check the trigger status and the delay on the General tab (default: 7 days after the order is Complete).
5. Optional: choose a reward promotion on the Review reward tab.
6. Send yourself a test e-mail from Marketing → Review requests (right column, Send a test e-mail).

From now on, every order that reaches the trigger status is queued. Orders placed before the installation are not queued automatically; use Marketing → Review requests → ⚙ → Queue orders of the last 30 days (or 90 days) if you want them.

Cron job

Due e-mails are sent by a cron job. Recommended, every 15 minutes:

*/15 * * * * php /path/to/store/admin.php --dispatch=kv_review_request_emails.cron

The exact line for your server is shown on the Sending tab of the settings. If you cannot run console commands, call the cron URL shown there (it contains a secret key) from an external scheduler.

Without a cron job, the setting Also send while administrators use the admin panel (on by default) sends due e-mails at most every 10 minutes, after an admin page has loaded. This is fine for small stores; a cron job sends on time.

Upgrading

Upload the new zip over the installed add-on in Add-ons → Manage add-ons (or install the Upgrade Center package). Your settings, requests, statistics and exclusions are kept. On the next admin page the add-on completes the upgrade by itself (new tables, settings and texts are added).

Uninstalling

Add-ons → Manage add-ons → Automated Review Requests → Uninstall removes the add-on’s tables (requests, statistics, unsubscribes, exclusions), settings, texts and e-mail templates. Active reward codes are withdrawn from their promotion. The reviews your customers wrote stay in your product reviews, and your promotions are not deleted.