Installation and setup

Requirements

• CS-Cart or Multi-Vendor 4.17.2 or later (Ultimate or Multi-Vendor edition).
• Administrator access to the store’s admin panel.
• A FedEx account number (the 9-digit number of the account that pays for shipments) and a project in the FedEx Developer Portal (developer.fedex.com): create a project, add the APIs Rates and Transit Times, Ship, Track, Address Validation and Pickup Request, and copy the API key (client ID) and secret key of the sandbox (test) and, after FedEx has approved the production key, of production. The FedEx Developer Portal explains how to move a project to production.
• A cron job on your server (see step 7).

Install the add-on

1. Download the kv_fedex_rest-<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 FedEx REST Rates & Labels 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 FedEx

1. Open Orders > FedEx shipments and the Connection tab.
2. Choose Test mode, enter the sandbox API key as client ID and the sandbox secret key as client secret, and the FedEx account number. Click Save and test: a green message means the credentials and the account number were accepted by the Rate API.
3. Fill in the Ship-from address (where parcels are sent from and picked up). Empty fields use your store details under Settings > Company. FedEx needs a street address, city, ZIP / postal code, country and a phone number of 10 to 15 digits.
4. Pick the defaults (packaging type, pickup type, label file type and stock, default package size). Leave the label stock empty to use the letter paper top-half label (PDF) or the 4x6 thermal label (PNG, ZPL).
5. Switch to Live mode and enter the production keys only after a successful test; test again.
6. Open Administration > Shipping & taxes > Shipping methods, add a method, choose the carrier FedEx REST Rates & Labels and one service under Rate calculation. Use the Configure tab for markup, rounding, free shipping and the fallback rate. Add one method per service you want to offer.
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 for all vendors (Marketplace owner mode on). Vendors can create labels and book pickups for their own orders only if you switch on Vendors may create labels; the marketplace owner’s FedEx account is billed then. Switch owner mode off to let each vendor connect their own FedEx account in the vendor panel (Connection tab); each vendor’s ship-from address is their own.

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, shipping services (with the shipping methods that use them) and database tables, including the stored credentials and labels.