This is the Lite version of the
UPS Online Advanced module. But don't let the name fool you. It offers nearly every option
available through UPS's online rate calculator (such as hazmat, declared value insurance,
box size, oversize, etc.). And the merchant can specify the maximum weight to put
into individual shipping boxes. The module uses a sophisticated algorithm to pack the boxes
to the maximum weight while maintaining the lowest number of boxes. The methods seen by the customer
in the drop down shipping selection list can be sorted either ascending or descending (or not at all).
NOTE: We have found that many new, not upgraded, 4.x stores are on servers that do NOT have the required UPS commerce library installed. You may need to install the UPS commerce library on your server (or have your host do it) before this module will work. Installation instructions can be found in the documentation for Empresa (the engine behind Miva), found here.
I will not attempt to detail the various UPS shipping methods
and the options available for them (there are simply too many). A very good place to
learn about the various methods can be found in the
UPS Service Guide. Keep in mind
when configuring the module and setting up your shipping that not all available
options are available for all methods. For example, the option to have Saturday Delivery
is not available with UPS Ground. If you configure the module to add the additional
shipping for saturday delivery, UPS Ground will not be an available shipping option for your
customers.
How the module does what it does
As with the standard UPS module, this module generates a list of available
UPS methods, with the associated rates for reach, from which the customer selects their
desired shipping method. To determine these rates, the module goes through the basket
and determines how many products there are and what they weigh. It then sorts the
products into boxes to determine the minimum number of packages to use. The "max weight per package" setting is
used to limit how much can be shipped in each package. The weights for these individual packages
are then used to calculate for each package a shipping rate for all of the methods (using the options set
on the main configuration screen).
Note that the method used to determine the number of boxes
to use to pack the products is not 100% accurate. Unfortunately, a method that
assured that degree of accuracy would take so long to run and require so much
computer power that no one would ever be able to check out of your store! However,
the method used, called a "first fit bin packing" algorithm is sufficiently accurate
to assure that extra shipping won't be calculated for the relatively small number of boxes
sent by the typical merchant. As the number of necessary boxes increases
the chance of mis-packing the boxes increases. In all instances the total
weight that shipping is calculated for will be the same; the total weight of the products
purchased. And if the method mispacks, it will always be in the favor of using too many
boxes.
In Merchant admin, expand your store, then click on the link to Shipping Configuration
under your store. In the right frame you will see a tab at the top for UPS Online Advanced Lite.
Clicking on that tab takes you to
The module's main interface:
Details on each feature of the main interface are listed below that feature in blue.
URL to UPS CGI Gateway:
This is the URL to the UPS script which provides the shipping rates. Don't
change this unless UPS changes things on their end.
Origination Zip code:
The zip code that will be used as the "originating" zip.
Sort:
none
Ascending
Descending
The order to sort the methods displayed to the customer in the drop down
shipping selection list. Sorted by shipping rate.
Message for 0 weight orders?
Normally, if the total basket weight is 0, the module will not generate any methods to
display in the drop down selection box shown to the customer. If no other shipping module
generates a method to show, Merchant will generate the "no available shipping methods"
message. However, if this option is checked, orders which have 0 weight, will have the
0 weight message inserted into the drop down list. This "shipping method" will have a
$0.00 cost.
0 weight message:
This is the message that will be displayed to the customer in the drop down payment
selection box if the total order weight is 0 and you have checked the "Message for 0 weight orders" option above.
Rate Chart:
The UPS rate chart (ie. how the transfer to UPS will occur).
Extra Handling Charge:
The handling that will be added to the determined shipping rate.
Note that this is NOT the UPS Additional Handling option (which you will find below).
Handling charged per-package?
If this option is checked, the handling charge will be added per-package (ie.
if the order is shipped in 3 packages the handling charge will be assessed 3 times).
If it is not checked, it will be added to all method's total shipping charge. Note that the
per-package option will NOT apply to packages that are shipped in their own packaging. If
however, the option is not selected (ie. NOT per-package), then the final rate that the
handling charge is added to will include the rates determined for the products shipping in their
own packaging.
Use Residential Rates?
Whether the destination address is a resident address.
UPS charges more for delivery to residences.
Available Shipping Methods:
Next Day Air
Next Day Air Intra (Puerto Rico)
Next Day Air Early AM
Next Day Air Saver
2nd Day Air
2nd Day Air AM
3 Day Select
Ground
Canada Standard
Worldwide Express Plus
Worldwide Expedited
Worldwide Express
To make a method available to the customer place a check
in the box next to the method name and click on "update". Note that even
though a method is indicated here to be "available", it might not be available
to the customer at the time of checkout. For example, the method "worldwide
Expedited" will not be available to customers within the US.
Package Details:
Packaging Type
Here you can configure the type of packaging that will be used to ship the product(s).
Max weight per package:
This is the maximum weight the module will attempt to pack into a box. The module
sorts through the products in the order and packs them into boxes in an efficient manner,
attempting to pack them into the least number of boxes. This weight is the limit to
how much it will attempt to pack into each box. The default upon installation is
the UPS maximum weight of 150 lbs.
Length
Height
Width
Oversize?
These values can be entered for you package if you want UPS to consider the package's
dimensions in calculating the shipping. Details on how UPS does this can be found
here. The "Oversize" option applies only to UPS Ground and UPS Standard to Canada.
You can find more information about that option here.
Optional UPS Services:
Declared Value Insurance?
Packages sent via UPS are insured for a value of $100. If this
option is checked additional insurance will be added to the cost of shipping for
product price over $100. The value used for this field is the basket price of the
product (ie. the price as it appears in the basket including attributes and options).
More information can be found about Declared Value Insurance here
Saturday Pick Up?
Saturday Delivery?
Verbal Confirmation?
COD?
Hazmat?
Additional Handling Charge?
Delivery Confirmation
Further information on all of the above options can be found in the
UPS Service Guide. The options available for each shipping method are listed
on that individual shipping method's description.
This module installs like any typical shipping module.
To install the module:
1.
If you prefer to ftp the module file (brok_upsa_lite.mv) to your server, do so now.
For convenience, place it into the Merchant2/modules/shipping directory. Note that
your Merchant scripts might NOT be installed in a directory called Merchant2/.
Although most setups use this directory. If your's uses a different directory,
make sure you put the module there
2.
Enter into admin and expand >Modules in the left frame.
3.
Click on the link to "Add Module"
4.
In the right frame, you'll see a text entry field with an "upload module" button
next to it. If you ftped the brok_upsa_lite.mv file to your server, enter
the path to that file into the text field (usually modules/shipping/brok_upsa_lite.mv).
Click on the "add" button. If you did not ftp the file to the server, click on the
'upload' icon next to the text entry field. This will pop up a small window. Enter
the path to the file on your local computer or click on the "browse" button to
browse your hard drive to find it. After you have the path in the text entry field
click on the "upload" key. When you're back to the right frame, click on the "Add"
button. After a short delay, you should see a notification that the module was
installed and you will see it at the bottom of the list of installed modules in
the left frame.
5.
The module is now installed into your "mall", but still needs to be installed
into your store. Expand your store. Then Expand >Shipping Configuration.
In the right frame, you will see the module listed near the top with a check box
next to the name. Check that box, and click on "update".
6.
The module is now installed into your store. You will see a new tab in the right
frame, UPS Online Advanced Lite. Clicking on that tab takes you to the
module's administration screen.
