Installation

Requirements

• CS-Cart Multi-Vendor 4.17.2 – 4.21.x (tested on Multi-Vendor 4.17.2 and Multi-Vendor 4.21.2 with PHP 8.3). The add-on is Multi-Vendor only; CS-Cart (Standard/Ultimate) refuses the installation with “Edition of your cart (ULTIMATE) is not supported. Required: MULTIVENDOR.”
• PHP 7.4 – 8.3, as supported by your CS-Cart version.
• The bundled Vendor plans add-on must be installed and active. It is a dependency and is active by default in Multi-Vendor.
• Optional: Vendor plans: Commissions by category. When it is active, products without a matching rule keep their category rate.

Install

1. Go to Add-ons → Manage add-ons, click the gear button and choose Manual installation.
2. Upload kv_vendor_commission_rules-<version>.zip and click Upload & install.
3. The add-on is active right away. It has no rules yet, so every order still gets the plan commission until you add rules.
4. On the License tab of the settings, enter your license key and save. If you bought the add-on on the CS-Cart Marketplace and entered the license number in Add-ons → Manage add-ons, you can skip this step. Until a key is verified, the add-on works for 14 days (see License).
5. Open Vendors → Commission rules to add the first rule.

Installation creates two tables (cscart_kv_vcr_rules, cscart_kv_vcr_log) and three privileges. No core files or core tables are changed.

Upgrade

Upload the new package over the installed add-on (same steps as installing). On the next admin page load the add-on brings its tables, settings and language variables up to date by itself. Rules, the log and settings are kept.

Upgrading to 1.1.0: this version adds the license check. After the upgrade the add-on keeps working for 14 days; enter your license key on the License tab of the settings within that time. Without a valid license, commission rules are no longer applied to new orders; orders placed before keep their commission (see License).

Disable

Disabling the add-on (status Off) stops the rule engine: new orders get the core plan commission again. Payouts recorded earlier keep their commission. The menu items and the vendor page disappear while the add-on is off.

To stop applying rules but keep the pages (simulator, report), turn off Apply commission rules to new orders in the settings instead.

Uninstall

Add-ons → Manage add-ons → Advanced Commission Rules → gear → Uninstall removes the rules, the commission log, the settings, the privileges and the language variables.

Vendor payouts are core data and are not touched: orders placed while the add-on was active keep the commission they were charged, so vendor balances do not change. New orders get the plan commission again.