Installation and setup

Requirements

• CS-Cart or Multi-Vendor 4.17.2 to 4.21.x (Ultimate and Multi-Vendor editions).
• Tested on CS-Cart 4.17.2 (Ultimate) and Multi-Vendor 4.17.2; templates compiled with the Smarty 5 engine of CS-Cart 4.21.2 (not yet run on a 4.21 store).
• Administrator access to the store’s admin panel.
• No external service, API key or cron job is needed.

Install the add-on

1. Download the kv_eudr_references-<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 EUDR Reference Numbers 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 inserts {{ snippet("kv_eudr_references") }} right after the products table of three documents in Design > Documents: the order invoice, the order summary (used by the order e-mails) and the packing slip. Documents you changed so much that they no longer contain the products table snippet are left alone; add the line by hand where you want the table (see Configuration).

First steps

1. Open Products > EUDR references. The header shows the application dates.
2. Mark your relevant products, in any of three ways:
   • open a product, tab EUDR, and enter its HS / CN code (for example 0901 21 00 for roasted coffee): a code listed in Annex I marks it as relevant;
   • add a category rule (tab Category rules), for example “Chocolate” = Cocoa;
   • import a CSV with the column hs_code (tab Import / export).
3. Add the reference number and verification number you received for the product (product tab EUDR, block Add a reference, or the CSV columns reference_number and verification_number). Add the batch if your references change per delivery.
4. Check tab Products of the add-on: the “Missing a reference” card lists what is still open.
5. Place a test order with a relevant product and open Orders > View orders > the order > Print invoice: the “EUDR due diligence references” table follows the products.

Multi-Vendor

Vendors see Products > EUDR references in the vendor panel for their own products and orders, the EUDR tab of their products and the import / export. Category rules and the add-on settings stay with the marketplace owner. Switch Vendors manage the EUDR data of their own products and orders off to give vendors read-only access.

Update

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

See the changelog for what changed in each version.

Uninstall

Open Add-ons > Manage add-ons, click the add-on’s gear button and choose Uninstall. The snippet call is removed from the documents.

The EUDR records (product settings, references, supplier data, order records, category rules) and the add-on settings are kept by default, because downstream operators and traders keep these records for at least five years. Installing the add-on again continues where you left off. To delete everything for good, tick Permanently delete all EUDR reference records on uninstall in the settings first, save, and then uninstall.