Installation
Requirements
Section titled “Requirements”- CS-Cart or Multi-Vendor 4.17.2 – 4.21.x.
- PHP 7.2.5 – 8.3, as supported by your CS-Cart version.
- MySQL or MariaDB with InnoDB (the wallet tables use InnoDB).
- A cron job is recommended (expiry, reminders, unpaid orders). Without one, the schedule runs once an hour while administrators use the admin panel.
Install
Section titled “Install”- Go to Add-ons → Manage add-ons and click the upload button (+).
- Upload
kv_customer_wallet-1.0.0.zipand click Upload & install. - Open the add-on (Store Credit Wallet) and enter your license key on the License tab, or the CS-Cart Marketplace license number in the add-on’s license field.
- Check the settings (see Configuration). The defaults let customers pay with store credit, return the credit of cancelled orders and give no cashback until you create a rule in Marketing → Cashback rules.
- Optional: set up the cron job shown in the settings.
The installation creates the wallet tables, two e-mail templates (Design → E-mail templates: Store credit changed, Store credit expires soon) and two privileges for administrator user groups: View store credit and Manage store credit.
Upgrade
Section titled “Upgrade”Upload the new version over the installed one (Add-ons → Manage add-ons → +, “Upload & install”). Balances, the ledger and the settings are kept; the add-on applies new tables, settings and texts automatically on the next admin page.
Disable
Section titled “Disable”Prefer the Enable the store credit wallet setting over disabling the add-on: with the setting off, customers cannot use store credit, but cancelled orders still give their credit back and the history stays visible.
When the add-on itself is disabled, CS-Cart does not run any of its code: checkout works without store credit, and status changes of orders that used store credit are not tracked until you enable it again. Balances and the ledger are kept.
Uninstall
Section titled “Uninstall”Uninstalling deletes the wallets, the ledger, the cashback rules, the settings, the texts, the e-mail templates and the privileges. All customer balances are lost. Export the wallets and the transactions (Customers → Store credit wallets, CSV) first if you need them. Orders are not changed.