Configuring the Shipping Module

Admin Configuration

The upsoauth shipping module provides the following configuration settings:

Title	Description
Enable UPS Shipping?	Indicates whether (True) or not (False, the default) the shipping module is currently enabled for use on the site's storefront.
Sort Order of the Display	The sort order for the shipping module (default 0) on the storefront.
Tax Class	The tax class to apply to any shipping charges, default none.
UPS API Class	If your site has an class-override for the shipping module's default (UpsOAuthApi), enter it here. If the class-file doesn't exist, this module will be automatically disabled!
Shipping Zone	The zone for which the shipping module is enabled, default all.
Client ID	The UPS-assigned Client ID used to gain the OAuth credentials. See this Wiki article that describes how to retrieve this and the Client Secret. Note that the shipping module will automatically disable itself if this value is an empty string.
Client Secret	The UPS-assigned Client Secret used to gain the OAuth credentials. See this Wiki article that describes how to retrieve this and the Client ID. Note that the shipping module will automatically disable itself if this value is an empty string.
Use this module in Test or Production mode?	Indicates whether the UPS testing (default) or production 'endpoint' should be used to retrieve UPS quotes.
UPS Rates Shipper Number	If your UPS account has 'negotiated rates' and you want these rates displayed on the storefront, enter your Shipper Number here.
Shipping Origin	Identifies the country-of-origin from which you ship packages for your store, default US Origin. This setting is used to determine the 'names' of the various UPS shipping methods displayed to the customer. It's also used as a means to determine whether an Origin Zip/Postal Code is required.
Origin Country	Identities the country from which your shipments originate; default US.
Origin State/Province	Identifies the state/province from which your shipments originate.
Origin City	Identifies the city from which your shipments originate.
Origin Zip/Postal Code	Identifies the zip/postal code from which your shipments originate. If your Origin Country uses a zip/postal code for its addresses, this field must be supplied to retrieve UPS quotes on your storefront!
Pickup Method	Choose how you deliver the to-be-shipped packages to UPS, one of Daily Pickup (default), Customer Counter, One Time Pickup, On Call Air Pickup, Letter Center or Air Service Center. Note that your choice here can have an effect on the pricing displayed on the storefront!
Packaging Type	Choose the type of packaging you use for your UPS shipments, one of Customer Packaging (default), UPS Letter, UPS Tube, UPS Pak, UPS Express Box, UPS 25kg Box or UPS 10kg Box. Note that your choice here can have an effect on the pricing displayed on the storefront!
Customer Classification Code	Choose the 'type' of UPS shipping rates to be returned, one of Rates associated with your Shipper Number [00], Daily Rates [01], Retail Rates [04] (default), Regional Rates [05], General List Rates [06] or Standard List Rates [53]. Your choice here has an effect on the pricing displayed on the storefront; the default value returns rates quoted by the ups.com 'Quotes' tool.
UPS Display Options	Choose the additional display options for the storefront, whether to display the number of boxes and their weights and/or the time-in-transit (the number of business days).
Shipping Delay	Identify the number of days that it will take your store to deliver any package to UPS for shipment (default 0). This value is added to the number of business days that UPS indicates it will take for a package to be delivered.
Unit Weight	Identify the weight unit, either LBS (default) or KGS in which the weights of your packages are sent to UPS. Make sure that the weight unit is correct for your Origin Country or no UPS quotes will be available!
Enable Dimensional Shipping?	Indicate whether ('true') or not ('false', the default) package dimensions should be included in rate requests. Added in v1.4.0
Dimension Unit	Identify the unit, either IN (default) or CM in which your products' dimensions are measured; sent when dimensional shipping is enabled. Added in v1.4.0
Quote Type	Indicate whether packages are sent to Commercial (default) or Residential addresses.
Handling Fee	Identify any handling fee, either a fixed amount or a percentage of the UPS-quoted amount, to be added to the pricing displayed for the quotes returned by UPS. The default value is 0. Removed in v1.3.0; per-method handling-fees are now provided.
Handling Fee: Next Day Air	Handling fee for Next Day Air shipments. The value you enter is either a fixed value or a percentage, e.g. 10%, of the UPS quote's value1. Added in v1.3.0.
Handling Fee: 2nd Day Air	Handling fee for 2nd Day Air shipments. The value you enter is either a fixed value or a percentage, e.g. 10%, of the UPS quote's value1. Added in v1.3.0.
Handling Fee: Ground	Handling fee for Ground shipments. The value you enter is either a fixed value or a percentage, e.g. 10%, of the UPS quote's value1. Added in v1.3.0.
Handling Fee: Worldwide Express	Handling fee for Worldwide Express shipments. The value you enter is either a fixed value or a percentage, e.g. 10%, of the UPS quote's value1. Added in v1.3.0.
Handling Fee: Worldwide Expedited	Handling fee for Worldwide Expedited shipments. The value you enter is either a fixed value or a percentage, e.g. 10%, of the UPS quote's value1. Added in v1.3.0.
Handling Fee: Standard	Handling fee for Standard shipments. The value you enter is either a fixed value or a percentage, e.g. 10%, of the UPS quote's value1. Added in v1.3.0.
Handling Fee: 3 Day Select	Handling fee for 3 Day Select shipments. The value you enter is either a fixed value or a percentage, e.g. 10%, of the UPS quote's value1. Added in v1.3.0.
Handling Fee: Next Day Air Saver	Handling fee for Next Day Air Saver shipments. The value you enter is either a fixed value or a percentage, e.g. 10%, of the UPS quote's value1. Added in v1.3.0.
Handling Fee: Next Day Air Early	Handling fee for Next Day Air Early shipments. The value you enter is either a fixed value or a percentage, e.g. 10%, of the UPS quote's value1. Added in v1.3.0.
Handling Fee: Worldwide Express Plus	Handling fee for Worldwide Express Plus shipments. The value you enter is either a fixed value or a percentage, e.g. 10%, of the UPS quote's value1. Added in v1.3.0.
Handling Fee: 2nd Day Air A.M.	Handling fee for 2nd Day Air A.M. shipments. The value you enter is either a fixed value or a percentage, e.g. 10%, of the UPS quote's value1. Added in v1.3.0.
Handling Fee: Express Saver	Handling fee for Express Saver shipments. The value you enter is either a fixed value or a percentage, e.g. 10%, of the UPS quote's value1. Added in v1.3.0.
Fixed Handling Fee, Order or Box?	If the handling fee is a fixed amount, should it be applied once per order (the default) or for every box? Added v1.2.0.
UPS Currency Code	Identify the 3-character currency code (default USD) used to identify monetary amounts (like package value) sent to UPS for the quote response. Make sure that the currency-code is correct for your Origin Country or no UPS quotes will be available!
Enable Insurance	Indicate whether (True, the default) or not (False) UPS insurance is to be added to any quotes returned from UPS.
Shipping Methods	Choose the various UPS shipping methods that you want to offer to customers on your storefront.
Display the USPS P.O. Box Caution?	Should a message display on the storefront to note that UPS does not ship to USPS P.O. Boxes? Select 'true' (the default) or 'false'. Added in v1.4.0.
Check for Updates?	Choose how you want the shipping-module to check for any updates on Zen Cart, either Always (default), Never or On Demand, when viewing the admin's Modules :: Shipping page. The On Demand setting will check once, when you save the setting, and then revert the setting to Never.
Enable debug	Indicate whether (true) or not (false, the default) the shipping module should create a debug output showing the rate request sent to UPS and the associated UPS response. The output (/logs/upsauth-Ymd.log) can be useful in determining why UPS rates are not being displayed.

¹ If you are upgrading the shipping-module from a version prior to v1.3.0, this value is initialized with the value previously set for the now-defunct "Handling Fee" setting.