Revision History

[ADDED] Support for multiple contact/contact after order flags added. Any number of messages can now be created by appending a number to the "contact" or "contact_after_order" flags to create a new flag (contact1, contact2 etc.). Any matching define in the languages file will have its text used as the message (defaulting to standard contact/contact after order text if no matching define is found).

[UPDATED] USPS Rate Calculator updated to use USPS's new V3 API, introduced on January 4th 2010.

[ADDED] Support for USPS GXG Envelopes, Priority Mail International Small Flat Rate Box, Priority Mail International Medium Flat Rate Box and Priority Mail International Large Flat Rate Box services added.

[REMOVED] USPS First-Class Mail International Package and First-Class Mail International Letter services have been discontinued so their support has been dropped from the module.

[BUGFIX] Correct text is now displayed in shipping estimator by Advanced Shipper when site doesn't use a textfield for the state.

[BUGFIX] Problems with updating of regions without admin titles fixed.

[ADDED] Information about new multiple contact/contact after order flag functionality added to documentation.

[ADDED] FAQ added about changing text for weight unit from Kgs to Lbs.

[UPDATED] Documentation updated with instructions about copying language file so it can be overridden.

[UPDATED] Last remaining uses of PHP's ereg functions migrated to using preg equivalent functions for full compatibility with PHP 5.3/6.0.

[ADDED] Improved support for the Countries/US Territories Guam, US Virgin Islands, Federated States of Micronesia, Northern Mariana Island, Marshall Islands, American Samoa, and Puerto Rico in the UPS and USPS calculators. UPS and USPS treat these countries/territories differently, with UPS seeing them as countries of their own and USPS seeing them as territories of the US.

[UPDATED] Code added to prevent problems when magic quotes is enabled.

[UPDATED] Length of textfield gadgets for method and region titles increased for greater ease of use.

[BUGFIX] Appropriate error message wasn't being displayed in shipping estimator when the state field wasn't being used.

[BUGFIX] Maximum limits were always matching between zero and the maximum value when no minimum limit was specified. Updated to match between any previous maximum limit the current maximum limit. The assumption is made that all limits or range of limits are entered in ascending order.

[ADDED] Support for UTF-8 added. Titles can now use any UTF-8 character (providing the Zen Cart installation itself has UTF-8 support enabled).

[ADDED] New calculation method added - totalorderprice - for matching against the total price of all the products for an order (not just the total price of the applicable products for a method!).

[ADDED] Support for minimum/maximum rates added for UPS and USPS calculation methods.

[ADDED] Support for Polish postcodes added.

[UPDATED] Default title for module being used in the language definitions file is no longer “Advanced Shipper”, but is now &lduqo;Shipping”. The information/FAQ about changing this title has been updated also. Should hopefully prevent people making mistakes and trying, wrongly, to remove the title altogether (which causes the module to not get displayed at checkout).

[BUGFIX] Recent surcharge functionality update resulted in flat rate surcharges no longer working, this has been fixed.

[BUGFIX] Combination rates would incorrectly discount a value if inclusive limits were being used and the first minimum limit being tested against matched the value. As this was the first limit, there could not have been a previous rate band to which the value would have belonged. The combination rate code now correctly sees the value as included in the first rate band.

[ADDED] Added support for block rates (for all of the rate calculation methods and surcharge calculation methods).

[ADDED] Geolocation support added for the US - full database of US zip codes now included as standard with the module!

[UPDATED] Surcharges can now use full tables of rates - dramatically increases their flexibility/usefulness! It's now easy to add on insurance for a method for example.

[UPDATED] The Advanced Shipper Config Utility now displays any store-side Region Title as well as the Region Admin Title in the method summaries.

[UPDATED] Geolocation functionality for the UK no longer rounds the calcuated distances, for slightly more accurate matching capabilities.

[UPDATED] Extra title for a method (e.g. UPS/USPS service information for the respectove quote) is now placed straight after the main method title if possible, otherwise it is appended to the method's title.

[BUGFIX] Region Admin Titles weren't being saved unless a store-side Region Title was entered.

[ADDED] Information about new block rates added to the documentation.

[UPDATED] Information about surcharges updated in documentation to use new format for surcharges.

[ADDED] Support for Czech Republic postcodes added to module.

[ADDED] Added support for adding a surcharge based on the number of packages being used to ship the applicable products for a method.

[ADDED] Added support for placement tags to be used to display information about the number of packages being used to ship the applicable products for a method, without having to display the full rate calculation.

[ADDED] Added support for a placement tag to place the “Extra Title” for a shipping method (the name of the shipping method as returned by live UPS/USPS quotes) at a specified position in the method's title, instead of it simply being appended to the method's title.

[BUGFIX] The packaging weight was being added on to packages after the contents of the packages had been worked out, according to any maximum weight per package setting. The packaging weight is now correctly being calculated at the time the contents of the packages are being worked out, so the checks against the maximum package weight are being compared to the overall package weight - i.e. that which includes the weight of the package as well as weight of the applicable products.

[BUGFIX] A surcharge title was being displayed in the method title when the surcharge was zero, it is no longer displayed when there is no surcharge.

[ADDED] Information about new placement tags and new number of packages options for surcharges added to the documentation.

[ADDED] New option added for regions, which calculates the total price of the applicable products including their tax, rather than the previous default of totalling up the price excluding tax.

[BUGFIX] Module was wrongly asking the customer to enter a state, when it couldn't find a usable rate, when the customer had typed a state in rather than having selected one from a state dropdown.

[BUGFIX] Negators for Country codes and Postcode Ranges were broken in versions 3.6.1 and 3.6.2.

[BUGFIX] Combination rates used by the Price and Weight calculation methods weren't displaying the rate calculations.

[BUGFIX] Maximum package weight functionality wasn't working properly with UPS and USPS calculators. Only the first quote was being properly totalled up and none of the quotes were returning the correct rate calculation descriptions.

[UPDATED] UPS and USPS calculators updated to inform the user if a post/zip code is required for the quote(s) to be calculated.

[ADDED] Several more FAQs added, mostly covering the formatting and display of the shipping information on both the store's catalog side and in the admin.

[UPDATED] Table of Contents added to FAQs page.

[BUGFIX] Combination rates didn't work with the “Number of items” rate definition method. This was broken in versions 3.4.0 - 3.6.1 but is fixed now.

[BUGFIX] Combination rates were wrongly including any fixed rate for a rate band when the rate limits inclusivity was set to inclusive. This should only have occurred if the limits were exclusive.

[ADDED] Support for Indian postcodes added to module.

[BUGFIX] Documentation about Spanish postcode ranges fixed to include correct format for range specification for city of Valencia.

[ADDED] Support for selecting multiple categories at once for a method added to speed up configuration of methods.

[ADDED] Support for selecting multiple manufacturers at once for a method added to speed up configuration of methods.

[BUGFIX] A mistake in the SQL file for versions 3.4.0 - 3.6.0 meant that any new installation of the module using this file would have an incorrectly configured column type for storing any Packaging Weight settings. Upgrades were not affected by this bug.

[BUGFIX] Any postcode range or country negations which matched the customer's shipping address resulted in no further regions being checked instead of the the current region simply being skipped.

[BUGFIX] If no products or categories were selected for a method but at least one manufacturer was, a message indicating that no categories/manufacturers/products had been selected was incorrectly being displayed in the method's summary.

[BUGFIX] Broken link to Nested Table of Rates information fixed in Rates section of documentation.

[ADDED] Maximum Weight Per Package setting added to allow a delivery to a region to be split into multiple packages if the applicable products weigh more than a specified amount.

[UPDATED] Checks added to surcharge configuration setting to prevent the use of invalid characters.

[ADDED] Documentation for Maximum Weight Per Package setting added.

[UPDATED] Minor documentation updates.

[BUGFIX] Surcharge titles weren't being saved if their region had no title entered.

[BUGFIX] Minimum/Maximum rates weren't being used by price-based tables of rates.

[BUGFIX] UPS calculator failed upon checkout because the httpClient class wasn't being loaded in at the checkout process stage.

[UPDATED] Text referring to “Product Catch-alls” for methods updated to more accurately use “Fallovers”.

[ADDED] Documentation for Minimum/Maximum rates and table of Packaging Weights added.

[ADDED] Support for imposing a minimum and/or maximum limit on the shipping rate added.

[ADDED] Support for table of packaging weights added. It is now possible to account for the packaging weight and include it in the weight calculation for the applicable products on a region by region basis (allowing for different packaging depending on the destination)!

[UPDATED] Fixed typos in the module, where “Manufacturers” was spelt incorrectly.

[UPDATED] Fixed typos in the documentation, in the introductions for the examples for the UPS and USPS calculators.

[BUGFIX] Module was failing when formatting numbers for display which had a comma in them (rates larger than 999).

[BUGFIX] PHP Warning message was being displayed when nested tables where being used.

[BUGFIX] USPS calculator failed upon checkout because the httpClient class wasn't being loaded in at the checkout process stage.

[ADDED] Support for New Zealand postcodes added to module.

[BUGFIX] IE only: The UPS and USPS calculators were being disabled if a region was edited in IE after they had been initially set up as IE wasn't setting the radio buttons properly (due to a bug in IE itself). Module updated to prevent this error from occurring.

[BUGFIX] Module was always defaulting to using a catchall to match the applicable products in the admin due a but introduced when the Manufacturer selection support was added.

[BUGFIX] The auto-upgrade script wasn't adding in the new Manufacturer table when upgrading from version 2.x to 3.2.x.

[UPDATED] Documentation updated with examples of Malaysian postcodes.

[BUGFIX] Warning is now displayed in the Advanced Shipper Configuration Utility when the module itself isn't installed.

[UPDATED] Documentation updated with information about new manufacturer's products selection support.

[ADDED] Module now detects if it is being used by the shipping estimator and varies its “No Quotes” error message depending on how much of the shipping address the customer has supplied in the shipping estimator. Should encourage the customer to enter more shipping information if a quote isn't found, thereby increasing the chances of a quote being generated and minimising the appearance of the “No Shipping Methods Found” message.

[UPDATED] Information about rate bands with a total cost of 0 is no longer displayed in the rate calculation description and flat rates of 0 are now marked as “Free”.

[BUGFIX] The surcharge amount wasn't being included in the value for the method_total placement tag.

[BUGFIX] Attribute information wasn't being added to the method title due to an incorrectly named placement tag.

[BUGFIX] Unused placement tags weren't being cleared from the method title.

[BUGFIX] The USPS calculator wasn't matching the correct service names in the response and therefore returning fewer quotes than expected.

[BUGFIX] Auto-upgrade script was broken.

[UPDATED] Support for dd.mm.yyyy date format added to module admin.

[UPDATED] Cancel button added to Category/Product selection popups.

[UPDATED] Message is now displayed in Category selectors if no categories exist yet.

[BUGFIX] Geolocation routine for the UK was comparing distances entered in the admin in Miles to distances returned by its algorithm in Metres! Miles are now compared against Miles once more!

[ADDED] Surcharge can now make use of combination rates for cumulative build-up of charge based on the weight/price/number of items or even the shipping rate itself!

[UPDATED] Combination rates' limits are no longer always inclusive, but use the same limits inclusivity settings as the table of rates.

[ADDED] Weight descriptions are automatically restricted to the most significant decimal place, for up to 5 decimal places (zeros are stripped from the end).

[UPDATED] Versioning system improved to automatically update point releases as well as major releases.

[BUGFIX] Leading/trailing spaces were wrongly being stripped when a method was being copied in the admin.

[BUGFIX] Rate calculation description functionality wasn't working properly - some parts of the title were being skipped.

[BUGFIX] Combination Rates weren't correctly using flat rate values.

[BUGFIX] Rate calculation template wasn't being appended to the default method title template.

[UPDATED] Documentation substantially updated to add information about new functionality, a better Table of Contents, Quickstart Examples and to update the sections on Method Titles, Rates and Handling Fees (now Surcharges).

[UPDATED] “Show Rate Calculations” setting removed from module as it is no longer necessary.

[BUGFIX] Placement tag functionality updated slightly to allow full usage within title templates as well as method titles themselves.

[ADDED] Method Sorting setting added. Non-dated methods can now be sorted by their admin order or their total cost.

[BUGFIX] Times for the method scheduling settings were being treated as midnight as the values being returned from the database weren't being parsed properly.

[ADDED] Basic error checking for missing calculation methods tags in tables of rates added.

[BUGFIX] Geolocation functionality wasn't working as the definition method check was wrong. Even with the correct check, the postcode being checked against wouldn't have been right so it would always have failed!

[BUGFIX] Module could go into an endless loop when postcode range matching was tested against in the shipping estimator.

[BUGFIX] Km conversion for distances wasn't correct in new Australian geolocation functionality.

[ADDED] USPS calculator class added. Tag “usps” can now be used in the table of rates to direct the module to contact USPS for a quote for the applicable products. Config panel to set up USPS calculator added, including support for specifying the “Source Country” and “Source Postcode” - allows drop-shipping of products from alternative locations (e.g. straight from the manufacturer)!

[UPDATED] Format of Table of Rates changed to use XML tags to specify the calculation method within the Table of Rates itself. Shipping Methods' “Calculation Method” settings are no longer used.

[ADDED] Module can now use embedded Tables of Rates instead of a specific rate. Allows using different calculation methods for a shipping method, based on the limits for the previous calculation method. (E.g. Price used up to 30.00, then weight used for any order value above 30!).

[UPDATED] “Handling Fee” renamed to “Surcharge”. New surcharge functionality includes ability to use percentage rates (and percentage+flat rates). Rates can now be calculated based on the weight, price or numitems for the applicable products or based on the shipping rate itself!

[ADDED] New output template system added for complete customisation of the output for a method combination (with product info) or a single method (with no product info).

[ADDED] Tag placement functionality added for method titles. Can now add information about the total cost, any rate calculation, any surcharge and the title of the region being shipped to!

[ADDED] Region Admin Title setting added. Descriptive region titles for the person configuring the shipping methods can now be used in the Advanced Shipper admin while a different, specific region title can be shown to the customer as part of the method's title (using the new placement tag).

[ADDED] UPS calculator class added. Tag “ups” can now be used in the table of rates to direct the module to contact UPS for a quote for the applicable products. Config panel to set up UPS calculator added, including support for specifying the “Source Country” and “Source Postcode” - allows drop-shipping of products from alternative locations (e.g. straight from the manufacturer)!

[ADDED] Flag contact_after_order added to Advanced Shipper module which warns customers that they have to contact the store after checkout to finalise shipping arrangements/costs. Allows customers to complete their order before having to contact the store.

[ADDED] Geolocation support added for Australian postcodes.

[UPDATED] The text "Free" is now displayed instead of “0.00” in rate calculations.

[ADDED] JavaScript added to admin so that pressing the Enter key in a text field/on a radio button will cause the form to be submitted instead of the next button in the form to be activated. Previously a Delete or Selection button etc. would have been activated when the Enter key was pressed (in Firefox) which was unintuitive/unexpected behaviour.

[UPDATED] Module no longer requires modification of a core file to get the splitPageResults class to work with the method SQL query.

[ADDED] Support for postcodes in Italy, San Marino and Vatican City added to the module, along with appropriate examples in the appendix.

[BUGFIX] Major bug found in module! Zen Cart was always defaulting to selecting the first shipping option as the Advanced Shipper module was building quotes for all available methods instead of only the selected method (and Zen Cart takes the first quote as the selected quote).

[UPDATED] Product Selector now automatically updates the Product Options selection panel when a new product is selected in the dropdown (Previously “Display” had to be pressed).

[BUGFIX] Selected categories/products were only being copied when a method was copied if the source method applied for specific categories/products only. Updated to copy selections when the source method acts as a "catch-all" as well.

[BUGFIX] Bug caused copying of methods to fail; wrong table name was being used in database query!

[ADDED] Support for Belgian postcodes added to the module, along with appropriate examples in the appendix.

[ADDED] Checks added to admin to help prevent invalid Handling Fees being entered.

[ADDED] Information about Handling Fees now displayed in method summaries (always) and region summaries (when defined).

[UPDATED] Module now uses PCRE functions instead of standard POSIX regular expression functions as the POSIX functions are being moved to PECL in PHP5.3+.

[BUGFIX] Catch-alls for products with attributes were being ignored at checkout!

[BUGFIX] Information about catch-alls for products with attributes wasn't being displayed in the main method listing and method configuration (for methods being edited).

[BUGFIX] Minor CSS kludge introduced to combat CSS layout problems of region control panel buttons due to buggy CSS implementation by IE.

[BUGFIX] Admin couldn't handle newlines in the tables of rates or countries/postcode fields. Can now cope with these characters and automatically adds spacing after commas, if necessary, for clearer presentation.

[ADDED] Support for the new Advanced Shipper Zones module added.

[ADDED] A new option for specifying rates added: a special “flag” can now be entered instead of a numerical rate, to have the module display a “Please contact the store for a personal shipping arrangement” message, instead of allowing customers to check out with the particular item(s) they have in their cart.

[ADDED] Checks added to enforce valid availability and/or shipping scheduling settings. Should prevent any erroneous date selections.

[ADDED] Checks added to admin to help prevent invalid Table of Rates being entered. Checks currently limited to limits/rates pairing format and limits format.

[BUGFIX] The additional flat rate charge wasn't being added on to the final total for percentage+flat rates.

[BUGFIX] Times weren't being reset properly in the Method Configuration in IE.

[BUGFIX] Plus (+) symbols in the Titles and Tables of Rates for Regions were going missing as only a single instance of the symbol was being encoded. All are now encoded properly so as many plus symbols as required can be used within these fields.

[ADDED] Support for negators added to Country Code matching.

[BUGFIX] Module wasn't handling plus signs in Region Titles or spaces in the Tables of Rates properly. Spaces can now be used in the tables of rates.

[BUGFIX] When being used in conjunction with the Advanced Shipper Localities module, if a region used a level 1 locality in its definition, any level 2 localities for that level 1 locality weren't being checked against the customer's level 2 locality, only the main level 2 locality was.

[BUGFIX] Module was incompatible with Zen Cart 1.2.x - now fully tested and working on 1.2.x!

[UPDATED] Debugging output substantially improved.

[UPDATED] Documentation updated due to user feedback - should be a little clearer in parts.

[UPDATED] Documentation updated to use new display class for better on-screen rendering. Better print output formatting also added. (Tested in IE6-7, Mozilla 2.x and Safari 3.x).

Complete Rewrite!

[UPDATED] Module completely rewritten to mirror real-life shipping methods. Backwards compatibility completely broken but functionality extended exponentially!

[ADDED] Product/Category selection support added. Individual products and entire product categories can now have their own specific shipping rates!

[ADDED] Locality support added. Can now work with Advanced Shipper Localities module to allow region definition using a set list of States/Localities/Cities.

Initial Release!