Installation and setup

Requirements

• CS-Cart or Multi-Vendor 4.17.2 or later (CS-Cart Ultimate or Multi-Vendor edition).
• Administrator access to the store’s admin panel.
• A UPS account number (the six character shipper number of the account that pays for shipments) and an app in the UPS Developer Portal (developer.ups.com): create an app, add the products Rating, Shipping, Tracking, Address Validation and Pickup, link your UPS account to it and copy the Client ID and Client Secret. The Developer Portal explains how to move an app from the test environment to production.
• A cron job on your server (see step 7).

Install the add-on

1. Download the kv_ups_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 UPS 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 UPS

1. Open Orders > UPS shipments and the Connection tab.
2. Choose Test mode, enter the Client ID and Client Secret of the app and the UPS account number. Click Save and test: a green message means the credentials were accepted and the account number was accepted by the Rating 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. UPS needs a street address, city, state (two letters for the US and Canada), ZIP / postal code, country and a phone number (10 digits for the US and Canada, 6 to 15 digits elsewhere).
4. Pick the defaults: prices at checkout (negotiated or published), pickup type, customer classification, packaging type, label file type (GIF or ZPL), default package size.
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 UPS 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 UPS account is billed then. Switch owner mode off to let each vendor connect their own UPS 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.