Print

UPS

Written by Valérie Isaksen on .

Back to store

This tutorial explains how to install and configure the UPS shipment plugin for VirtueMart2.

 

 

Create a test account on UPS

  1. Create a UPS login at UPS.Com. Click on My UPS and Register   to create an account.
  2. Request a developer API key at www.ups.com/upsdeveloperkit  and follow the steps from that page.

You will receive an email with all the informations and the API key.

A usefull post on the forum on how to get a UPS Access Key

Install the UPS plugin

  1. Install the UPS plugin via the Joomla Installer
  2. Enable the UPS plugin

Check your shop configuration

The UPS plugin works worldwide. ANd the UPS services are different depending on origin of your shop. The plugin uses the shop information to display the correct list of services.
  1. Go in Shop > Shop menu, click on the Tab Shopper information
  2. Check that your address, ZIP code, and country is correct.

Configure UPS as shipment method

  1. Go to component VirtueMart
  2. Create a new shipment method, and select UPS, click Save
  3. Go on the Configuration tab
  4. If you are shipping from the same address as your shop, select Use shop address. If you are shipping from another address, select Use warehous address, and enter all informations
  5. Enter the informations provided by UPS:
    • Api Key
    • User Password
    • MyUPS User ID (user name)
    • UPS Account Number
  6. Choose the Delivery Services. UPS offers a wide variety of package delivery services.
    Valid domestic values:
    • Next Day Air Early AM
    • Next Day Air
    • Next Day Air Saver
    • 2nd Day Air AM
    • 2nd Day Air
    • 3 Day Select
    • Ground
    Valid international values:
    • Standard
    • Worldwide Express
    • Worldwide Express Plus
    • Worldwide Expedited
    • Saver
    Complete list of the delivery services depending on the originating country.
  7. Select the UPS pickup method. The options are :
    • Daily Pickup
    • Customer Counter
    • One Time Pickup
    • On Call Air
    • Suggested Retail Rates
    • Letter Center
    • Air Service Center
    The default value is Daily Pickup.
  8. Select the Customer classification. The options are:
    • None
    • Wholesale
    • Occasional
    • Retail
    The Customer Classification determines the rate returned by UPS. This parameter must be different from 'None' when the Pickup method is set to 'Suggested Retail Rates'. It is only used in case your ship from address is in US.
    The default values depends on the UPS pickup method:
    • The default value is Wholesale when the Pickup method is daily pickup.
    • The default value is Occasional when the Pickup method is One Time Pickup or On Call Air or Letter Center or Air Service Center
    • The default value is Retail when the Pickup method is Customer Counter
  9. Choose the Packaging. The options are:
    • Unknown
    • Ups Letter
    • Package/customer supplied
    • UPS Tube
    • Express Box
    • 25KG Box
    • 10KG Box
    • Pallet
    • Small Express Box
    • Medium Express Box
    • Large Express Box
  10. Select the Shipment strategy
    • Based on weight: the number of packages needed is calculated dividing the total weight of the products with the maximum package weight allowed. 
    • Based on volume: the number of packages needed is calculated by dividing the total volume of all products with the maximum package volume defined in the parameter Boxes dimension
    • Each product sent as one package: each products is put into one package
  11. Enter the Boxes dimension and select the Dimension unit of the boxes only when the parameter Shipment strategy is set to Based on volume
    1. Select if you want that the returned UPS shipment rates include an Insured value (more expensive).
  12. Set Local Weight Unit to the system you use to measure product weight. The weight system supported by UPS varies by country (example LBS for USA, KGS for France).
  13. Weight Padding and Dimensions padding allows you to pad the weight  or dimensions for shipping package
  14. Select the Destination type to which the shipment is being sent. The options are:
    • Auto: based on delivery address entered by the client during checkout, the UPS shipment plugin will determine if the address is residential or commercial depending if the company name is filled or not,
    • Commercial
    • Residential: A residential delivery is defined as delivery to a location that is a home, including a business operating out of a home.
    UPS charges residential deliveries more than commercial ones for their Ground shipping (typically $1 or $2 more).  
  15. Free shipment: enter an amount for which the shipment is offered. Do not enter any value, if you do not offer shipment
  16. Select the Accepted Countries for the shipment. If no country are selected, the shipment is available for all countries.
  17. Choose a logo for your shipment
  18. Select Yes or No  for Charge Tax
  19. Choose the Tax Rule

Test your installation

Attention: Be sure your products have weights entered.

  1. Add a product to your cart
  2. Click on Select shipment: all the available services and rates are displayed.
 

Trouble shooting

 
Q: We are sorry, no shipment method matches the characteristics of your order.
 
Reason 1: Most of the time, the reason for that message is a wrong Delivery Service configuration. To check that this the reason, log in as vendor on the front end, and do a checkout. The following message will be displayed, followed by the delivery Services actually returned by UPS, and the delivery services that you have configurated in your shipment method. 

Info: UPS: The delivery services configurated in the shipment method do no match the Delivery Services returned by UPS.
If they do not match, then no shipment is listed. 

 

UPS infos displayed when no delivery services are avaiable

Check the complete list of the delivery services depending on the originating country, and change the parameter Delivery Services according to your originating country, and the destination countries.

Reason 2: Another possible reason is that you have not set weigth for your products. Just like before, to check that this the reason, log in as vendor on the front end, and do a checkout. The following message will be displayed: Packages must weigh more than zero pounds.
UPS-weigth-zero

Check that all your products have a weigth.

Reason 3: Another possible reason is that you have the weigth is over the maximum limit autorized by UPS. Just like before, to check that this the reason, log in as vendor on the front end, and do a checkout. The following message will be displayed: The maximum per package weight for the selected service from the selected country is xxx pounds.

UPS-max-weigth

 

UPS has established specific weight and size limits for the packages that you send with all UPS services.

Learn More About UPS Weight and Size Limitations
Learn More About Shipping Packages Greater Than 70 lbs (32 kg)

Additional weight and size limitations may apply to either your destination or origin country when shipping to and from the United States.Find Country-Specific Weight and Size Limitations

 

Q: I have selected UPS standard, and I get the message "We are sorry, no shipment method matches the characteristics of your order."

A: UPS standard is not a service used for US Domestic deliveries. 
http://www.ups.com/content/us/en/shipping/time/service/standard.html describes when this service is used. 

Q: This message is displayed: Cannot select UPS shipment Info : This measurement system is not valid for the selected country.

A: Change in the UPS shipment configuration the parameter Local Weight Unit to change from lbs and ounces to Kilograms or vice-versa.

Q: No rates are displayed
A: Go in the Joomla configuration, enable the Error Reporting to Maximum. You  may have this error displayed:

Warning: curl_exec() has been disabled for security reasons in /xxx/yyy/vhosts/mywebsite/plugins/vmshipment/istraxx_ups/istraxx_ups.php on line 868

The function Curl is deactivated on your server. Contact your web hoster to enable it.

Q: My rates are different from the ones I had in VM1

A: The UPS installed in VM1 has using the package type: "Unknown". Select the same package type in the plugin.

Q: Fatal error: Class 'DomDocument' not found in /var/www/html/plugins/vmshipment/istraxx_ups/istraxx_ups.php on line 934

A: Check that php-xml is installed on your server. If it is installed, check that the plugin has been correctly installed.

Verifying Shipping Rates

The US online calculator is a really usefull tool, it helps you to determine the available services form your wharehouse to the delivery point, and also the rate and delivery time. It helps you to understand which delivery service feets best your needs.  Oneline calculators are available for each country posting countries. 
When comparing shipment charges between plugin and the UPS online calculator tool providing the rates, be sure that the requests are identical.

Negociated Rates

Negotiated Rates are available in the UPS Customer Integration Environment and are returned when the Negotiated Rate parameter is set to Yes. The Negotiated Rates returned do not reflect the contractual rate and may vary. (A flat 1% discount is returned).
Shipping rates quoted are estimates based on the information supplied. Other shipping charges may apply and the final shipping charge may differ depending upon UPS Account Number and how the package is tendered to UPS. Please see the applicable UPS Rate and Service Guide for details.

When comparing shipment charges between applications and API providing UPS rates, be sure that the requests are identical. Working through any discrepancies will require knowledge of all parameters posted along with defaults, numeric rounding, and rate table used by the applications being compared.
For more information on UPS Services, refer to the UPS Service Guide
You can check your results against the UPS Quick Cost CalculatorTM web application.

Usefull links

Complete list of the UPS services depending on the originating country

Please read the UPS Rate and Service Guide, section choosing a Service to determine the package service that best meets your needs, or read this page http://www.ups.com/content/us/en/shipping/time/service/index.html
The following lists the service code values for shipping services; they are ordered by the origin of the shipment

United States Domestic Shipments

  • UPS Next Day Air®
  • UPS Second Day Air®
  • UPS Ground
  • UPS Three-Day Select®
  • UPS Next Day Air Saver®
  • UPS Next Day Air® Early A.M. SM
  • UPS Second Day Air A.M.®
  • UPS Saver

Shipments Originating in United States

  • UPS Next Day Air®
  • UPS Second Day Air®
  • UPS Ground
  • UPS Worldwide ExpressSM
  • UPS Worldwide ExpeditedSM
  • UPS Standard
  • UPS Three-Day Select®
  • UPS Next Day Air® Early A.M. SM
  • UPS Worldwide Express PlusSM
  • UPS Second Day Air A.M.® 65 UPS Saver

Shipments Originating in Puerto Rico

  • UPS Next Day Air®
  • UPS Second Day Air®
  • UPS Ground
  • UPS Worldwide ExpressSM
  • UPS Worldwide ExpeditedSM
  • UPS Next Day Air® Early A.M. SM
  • UPS Worldwide Express PlusSM
  • UPS Saver

Shipments Originating in Canada

  • UPS Express
  • UPS ExpeditedSM
  • UPS Worldwide ExpressSM
  • UPS Worldwide ExpeditedSM
  • UPS Standard
  • UPS Three-Day Select®
  • UPS Saver
  • UPS Express Early A.M. SM
  • UPS Worldwide Express PlusSM
  • UPS Saver

Shipments Originating in Mexico

  • UPS Express
  • UPS ExpeditedSM
  • UPS Express Plus
  • UPS Saver

Polish Domestic Shipments

  • UPS Express
  • UPS ExpeditedSM
  • UPS Standard
  • UPS Worldwide Express PlusSM
  • UPS Saver
  • UPS Today StandardSM
  • UPS Today Dedicated CourrierSM
  • UPS Today Intercity
  • UPS Today Express
  • UPS Today Express Saver

Shipments Originating in the European Union

  • UPS Express
  • UPS ExpeditedSM
  • UPS Standard
  • UPS Worldwide Express PlusSM
  • UPS Saver

Shipments Originating in Other Countries

  • UPS Express
  • UPS Worldwide ExpeditedSM
  • UPS Standard
  • UPS Worldwide Express PlusSM
  • UPS Saver

Freight Shipments

  • Trade Direct Cross Border
  • Trade Direct Air
  • Trade Direct Ocean
  • UPS Freight LTL
  • UPS Freight LTL Guaranteed
  • UPS Freight LTL Urgent