Documentation

Installation Steps:

  1. Install the module:
    Dashboard > Add Funtionality > New > coreCommerce - UPS Shipping - 1.0 > Install
  2. Sign up for a UPS account (in the US: https://www.ups.com/account/us/start)
  3. Obtain a Developer's key (https://www.ups.com/servlet/registration)
  4. Using the Developer's key from the previous step, obtain an XML Access Key for the UPS Rates & Service Selection Tool (http://www.ups.com/e_comm_access/rates)
  5. Configure the UPS Shipping Module in Concrete5
    1. Go to: Dashboard > coreCommerce > Shipping > UPS Shipping
    2. Enable the module
    3. Enter your UPS User ID (from step 2)
    4. Enter your UPS Password (from step 2)
    5. Enter your UPS Account # (from step 2)
    6. Enter your UPS Access key (from step 4)
    7. Enter your country and the zip/postal code you will be shipping from
    8. Enter your packaging information
    9. Select the pickup type that will be used (how UPS will obtain packages from you)
    10. Choose an operation mode - testing or live
  6. Click "Update Shipping Type"

Frequently Asked Questions

Q: I get "Shipping is Unavailable" when I check out.  What's wrong?
A: There are several things that can cause this problem:

  1. You don't have the UPS shipping method enabled.
  2. You have entered your UPS account, password, or XML key incorrectly.
  3. The shipping address provided is invalid (UPS will not compute rates for invalid addresses).
  4. You have selected to ship to only certain countries and the destination country is not in that list.
  5. UPS does not offer a shipping method using the address or parameters provided (e.g. the products ordered are all very heavy, but you only offer next day air shipping).
  6. You have configured the module to use product dimensions to compute rates, but the values you entered for the maximum box dimensions are too large.  The module computes an average weight based on the size of the maximum box dimensions. Different UPS shipping services allow different maximum package weights.  If you the dimensions you entered are for a very large package, the estimated weight may be greater than the maximum weight UPS allows.  You can check to see if this is the case by looking in the Concrete5 logs (Dashboard > Reports > Logs) for an error message to this effect.
  7. Some other error is occuring.  Check the Concrete5 logs (Dashboard > Reports > Logs) for more information.

Q: The rates being returned are higher than the rates quoted on the UPS web site. Why?
A: There may be several reasons for this, but the two most likely are:

  1. The UPS web site will return the wholesale rate for some combinations of shipping methods and options, whereas the UPS module takes a more conservative approach and computes regular retail rates.
  2. On the UPS web site you can enter the type of address a package will be shipped to (business or residence).  It's generally cheaper to ship to a business than a residense.  The UPS module does not, however, have any way to tell if an address is a business address or a residential address so it presumes all addresses are residential addresses.

Q: I want the UPS module to compute costs using product dimensions, but I don't have a "maximum box size".  What should I enter?
A: You can leave the maximum box size field blank (or set to 0).  In this case the module will ask UPS to compute the rate for each package independently.

Q: Why am I getting the same shipping rates after I enable or disable shipping methods or after I change some of the other shipping options?
A: The coreCommerce package requests shipping rating information from the UPS module several times during the checkout process. Since the module must retrieve this information from UPS and this request can take a few seconds each time, the rate information is cached.  There are three ways to force the UPS module to recompute the rates and services:

  1. Use test mode while you are still updating your site.  Caching is disabled in test mode.
  2. Update your order. The UPS module will refetch the rate information if the order number changes or the items in the cart change.
  3. Delete your browser cookies.

Q: What is debug mode?
A: Debug mode is a setting that tells the UPS package to log record all XML requests and responses from UPS to the Concrete5 log, which is accessible from the dashboard.  It is sometimes useful to have the raw input and output data when debugging problems with the UPS API.  Please note that when debug mode is enabled a lot of relatively large log messages may be created.  You should never leave debug mode enabled in a live production environment. It should only be turned on when it is necessary to debug problems with the UPS API.

Q: How are the Large Box Dimensions settings used? 
A: Most businesses will ship several smaller items together in a larger box.  This saves shipping costs.  The UPS add-on uses the Large Box Settings to estimate how smaller items might be packaged for shipping and much it will cost to ship the larger boxes.  

Q: When I enable Product Dimensions why don't I get any shipping rates or why are all the rates so high? 
A: Make sure your Large Box Dimesions are not too large.  These settings are not necessarily intended to be the dimensions of the largest item you ship.  They are supposed to be the dimensions of the largest box you commonly use to ship a combination of smaller items.  The UPS add-on computes an estimate weight for the Large Box based on a value commonly used in the shipping industry.  If your Large Box Dimensions are very large the computed weight for the box may be higher than the maximum weight for many shipping methods.