Installation and setup

Requirements

• CS-Cart and Multi-Vendor 4.17.2 or later.
• Administrator access to the store’s admin panel.
• A Royal Mail Click & Drop account (pay as you go or OBA) and an API key. In Click & Drop open Settings > Integrations, add a new integration and choose Royal Mail Public API; copy the key it shows. Label download through the API is available to OBA accounts only (Royal Mail’s rule).
• A cron job on your server (see step 7).

Install the add-on

1. Download the kv_royal_mail-<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 Royal Mail Click & Drop Shipping in the list and make sure its status is Active.
5. Enter your license key under Settings > License (Kavio Labs downloads) and click Check now.

Connect Royal Mail

1. Open Orders > Royal Mail shipments and the Connection tab.
2. Paste the API key, choose the Account type (pay as you go or OBA) and click Save and test. A green message lists the carriers of your account.
3. Under Click & Drop service codes choose, for each checkout service, the Click & Drop service that its orders use (the list is read from your account). Left on Account default, Click & Drop applies the service of your account settings.
4. Open the Rates tab and enter your prices (Load example bands inserts illustrative bands that are not Royal Mail’s prices; replace them with the prices of your own Royal Mail price list).
5. Open Administration > Shipping & taxes > Shipping methods, add a method per service, choose the carrier Royal Mail Click & Drop and the service (for example Royal Mail Tracked 24), set the rate calculation to real-time and save.
6. In Multi-Vendor, vendors need the method assigned to them (Vendors > edit > Shipping methods).
7. Add the cron job from the settings page (Cron section), every minute is fine. Overlapping runs are prevented.

Multi-Vendor

By default the marketplace owner connects one account and one rate table for all vendors (Marketplace owner mode on). Switch it off to let each vendor connect their own Click & Drop account and maintain their own rates in the vendor panel.

Update

1. Upload the new package the same way. Your settings, credentials, rates and data are kept.
2. The add-on adds missing tables and settings by itself on the first request after the update.

See CHANGELOG for what changed in each version.

Uninstall

Open Add-ons > Manage add-ons, click the add-on’s gear button and choose Uninstall. This removes the add-on’s settings, language variables, the Royal Mail shipping methods and database tables, including the stored API key and the rate table.