Installation and setup

Requirements

• CS-Cart and Multi-Vendor 4.17.2 or later.
• Administrator access to the store’s admin panel.
• A Sendcloud account with at least one carrier you can ship with (Sendcloud prices or your own carrier contracts) and a Sendcloud API integration (Settings > Integrations > Sendcloud API) for the public and secret key. Sendcloud has no separate sandbox host: for tests keep a second throw-away integration and use its keys as the test credentials.
• A cron job on your server (see step 6).

Install the add-on

1. Download the kv_sendcloud-<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 Sendcloud 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 Sendcloud

1. Open Orders > Sendcloud (the add-on page) and the Connection tab, or Add-ons > Manage add-ons > Sendcloud Shipping > Settings and click Connection.
2. Choose Test mode and enter the public key and secret key of your Sendcloud API integration. Save and click Test connection: a green message means the keys work and shows how many shipping options your account has.
3. In Sendcloud open Settings > Integrations, click Configure on your Sendcloud API integration, switch on Webhook feedback enabled and paste the Webhook URL shown on the Connection page. Events are signed with your secret key; only integration types that have a separate webhook signature key need it entered in Webhook signature key (optional).
4. Switch to Live mode and enter the live keys only after a successful test; test again.
5. Open Administration > Shipping & taxes > Shipping methods, add a method, choose Rate calculation: Real-time and the carrier Sendcloud with the service Sendcloud: home delivery or Sendcloud: service point. On the Configure tab choose carriers, strategy and price rules. Add the usual weight and location restrictions as for any method.
6. 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 for all vendors (Marketplace owner mode on): labels are bought with the owner’s Sendcloud account and ship from each vendor’s company address. Switch it off to let each vendor connect their own Sendcloud account in the vendor panel (Connection tab).

Update

1. Upload the new package the same way. Your settings, credentials 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 and database tables, including the stored keys and the Sendcloud shipping methods.