page last edited on 24 January 2018
This article assumes that the UPS addon has already been installed and activated at your store.
To start using the addon, you need to configure it. The addon settings can be accessed using one of the following methods:
In the Shipping section of your X-Cart store’s Admin area (Store setup > Shipping), click the Add shipping method button.
In the popup that appears, choose the UPS shipping method.
In the My addons section of your X-Cart store’s Admin area, find the UPS addon and click on its name to access the addon detailed information.
On the addon information page, click on the Settings link.
The UPS settings page looks like the following:
To use UPS Rating API you need to register on UPS.com with a User ID and Password. Once you have registered you would need to obtain an Access Key from UPS.com that provides access to the Rating API. To obtain an Access Key an account number needs to be added or created in your UPS.com profile.
So first of all you’ll need to fill in the following fields in accordance with your UPS account data:
- User ID: Specify your UserID.
- Password Specify your password.
- Access key: Specify your UPS Access key. An Access key can be requested after registration. To request an Access key, go to https://www.ups.com/upsdeveloperkit?loc=en_US and click “Request an access key”. On the page that opens, provide your contact and account information and select “Request Access Key” to continue. Once you have your Access key, copy and paste it into this field in X-Cart.
- UPS Account number: Specify the UPS account nember. A shipper’s UPS account number is required when requesting to receive the negotiated rates.
- Test mode: Turn the test mode on if you want to check the UPS shipping processing before making it live.
These are the options that will be applied to both domestic and international shipments:
- Package box type: Select the type of packaging that will be used for shipments.
- Package dimensions (IN) (Length, Width, Height): Use these fields to define the default package size for UPS shipments in inches.
- Maximum package weight (lbs): Specify the top limit of package’s weight in lbs.
These are advanced options for shipments.
Turn them on or select the necessary values if applicable.
Cash on Delivery
Here you can enable the cach on delivery option for your inetrnational and domestic shipments.
To enable the cash on delivery option for shippings you should first activate this option in the payments section (Store setup > Payment methods). Find UPS in the Offline methods section and turn the cash on delivery option on.
Follow the link from the Note to find the payments section
Currency Conversion Options
Use this section to provide a currency convertion rate if your currency is other than the US dollar.
- Shipping cost currency: If the shipping currency is other than USD, specify it in this field.
- Currency rate: Set the currency conversion rate here. If your currency is the US dollar, leave this field set to 1.
This is an option that is helpful, but do not affect shipping rates calculation:
This option enables logging of requests to the UPS server and responses from it. The logs are saved to UPS.log files in the
Don’t forget to save the changes when the UPS shipping configuration is complete.
Help make this document better
This guide, as well as the rest of our docs, are open-source and available on GitHub.