Installation and setup

Requirements

• CS-Cart or Multi-Vendor 4.17.2 to 4.21.x (CS-Cart, CS-Cart Ultimate, Multi-Vendor and Multi-Vendor Ultimate editions).
• PHP 7.4 to 8.3.
• Administrator access to the store’s admin panel.
• No external service or API key. A daily cron job is recommended (see below); without it, products are still checked when they are saved and with Scan now.

Install the add-on

1. Download the kv_green_claims_checker-<version>.zip package from your Kavio Labs or CS-Cart Marketplace account.
2. In the admin panel, open Add-ons > Manage add-ons.
3. Click the gear button and choose Manual installation, then upload the archive.
4. Find Green Claims Checker in the list and make sure its status is Active.
5. Enter your licence key under Settings > License (Kavio Labs downloads) and click Check now. Marketplace buyers can leave it empty when the Marketplace licence number is entered in Add-ons > Manage.

On installation the add-on creates its tables and fills the default English term list (about 100 terms) and the allow-list (EU Ecolabel and common context phrases such as “green tea”). Nothing changes in your product data and nothing is shown on the storefront.

First steps

1. Open Products > Green claims.
2. Click Scan now. The catalog is checked in batches while the page is open (about 250 products take a few seconds on a small server; you can leave the page and continue later).
3. Look at the dashboard: products with high findings, open findings by rule, the most frequent terms and where they are (name, description, features…).
4. Open Findings, filter by Severity: High, and open a product from the list. The Green claims tab of the product shows every finding with its context.
5. Fix the text in the product, or select findings and Accept with evidence when the claim is supported (for example “EU Ecolabel licence FR/030/001” or “specification shown in the same paragraph”).
6. Review the Term lists: add terms for the languages you sell in, lower or raise severities, and disable terms that do not fit your catalog.

Cron job (recommended)

Settings > General shows the exact command and URL with your key. Run it once a day:

0 3 * * * php /path/to/store/admin.php --dispatch=kv_green_claims_checker.cron --key=<key>

or call https://<your store>/index.php?dispatch=kv_green_claims_checker.cron&key=<key> from your host’s cron panel. The cron run continues the scheduled full scan (weekly by default) and re-checks queued products: products changed by imports, bulk edits or the API are queued instead of being checked during the request.

Multi-Vendor

• Settings > Vendor moderation > When a vendor saves a product with findings: Do nothing, Warn the vendor (default), Require review, or Block.
• Hold from severity: High (default) or Medium and high.
• Vendors see their findings: vendors get Products > Green claims for their own products (dashboard, findings, CSV export, Scan now for their own catalog, replace in their own texts). Accepting findings, the term lists, the allow-list and the submissions queue stay with the marketplace owner. Under Require review or Block, vendors always see the Green claims tab of their products.

Update

1. Upload the new package the same way (Manual installation over the installed add-on). Your term lists, allow-list, findings and settings are kept.
2. The add-on adds missing tables and settings by itself on the first admin request after the update.

Uninstall

Uninstalling removes the add-on tables: the term lists, the allow-list, the findings, the review evidence and the undo history of replacements. Export the term list (Term lists > Export term list) and the findings (Findings > Export CSV) first if you want to keep them. Product texts and product statuses are not changed by uninstalling; products that were held for review stay disabled until you activate them.