CFWebstore® uses the UPS API to automatically retrieve rates for your customers based on the total weight of their order and present a list of available UPS shipping methods. You will also be able to use UPS address verification and tracking features. You will need to go through a number of steps to get your store set up with the UPS shipping.
UPS Developer API Settings
To use the UPS rates in CFWebstore you will need to register for the UPS Online Tools and get a developer API access key, username and login. This information will be used to give you access to the online rates and tracking tools. You can register online at https://www.ups.com/upsdeveloperkit.
Once you have registered, enter your access information in the form and save it to configure the store to use the UPS tools.
The next step is to configure your basic UPS settings. Be sure to do this before trying to configure your shipping methods! Click UPS Settings from the main Shipping Settings screen to view these settings:
Maximum Package Weight – The maximum weight to include in a single package for shipping. Once an order exceeds this weight, it will be split into multiple packages (of equal weight). If you are using drop-shippers, the packages will be split for each drop-shipper separately.
Units of Measurement – The weight and dimensional units to use for your store. These should match what you configured in the Main Settings and should be appropriate for your country or the UPS API may not be able to properly determine rates.
UPS Account Type – The account type to use in determining rates, sets if you drop off packages or have a pickup account with UPS.
Package Type – The package type to use in determining rates, typically this is set to use your own packaging.
Shipper’s Zip/Postal Code – The default postal code packages are being shipped from. This is required information for any country that uses postal codes.
Shipper’s City – The default city that packages are being shipped from. This is only used for shippers in countries that do not use postal codes.
Shipper’s Country – The county packages are being shipped from.
Origin for Rates – UPS groups shipping rates by “origins”. Select the one that matches the country you are shipping from. It’s important you set the correct origin here for accurate rates!
Use Address Verification – This is only available for US merchants. This will run an address verification test on the shipping address of the customer during checkout to see if it is valid. If invalid, a list of possible corrections will be given.
Log Transactions – This will log all API transactions to and from the UPS server to a file in the logs directory. Since this file can get really large with normal store use, this setting is typically left off unless you need to debug a shipping issue with a live store.
Debug – If this setting is turned on, the API transactions to and from the UPS server as well as some internal shipping structures will be written out to the page during checkout. This is generally only turned on for development purposes and shouldn’t be used with a live store.
Click Save to save your settings and Cancel to return to the main Shipping Settings screen.
UPS Shipping Methods
The Shipping Method section will automatically be configured according to the Origin for Rates as selected in the UPS Settings area. A list of available methods will be displayed, for each you can select if this is a method you want to offer to customers and you can also enter the sort order to determine what order to display them in. UPS does not allow any modification to the names of the shipping methods as per their licensing agreement, so this is set internally, along with the API codes. Be sure that you have at least one shipping method turned on or your store will be able to calculate any rates. Also note that not all methods are available to all addresses. If you are shipping overseas for instance, ground methods would usually not be available. You can use the logging feature to see exactly what methods are being returned for a particular address.
After entering your selections for methods to use and the sort order (if any) click Update Used to save your changes.