WooCommerce / UPS Small Package Plugin

/WooCommerce / UPS Small Package Plugin
WooCommerce / UPS Small Package Plugin2018-11-10T19:20:00+00:00

Small Package Quotes

UPS Edition for WooCommerce

UPS is headquartered in Sandy Springs, Georgia and is the world’s largest package delivery company. UPS delivers more than 15 million packages per day to more than 7.9 million customers in more than 220 countries and territories around the world. If you don’t have a UPS account number, contact them at 800-742-5877, or register online.

Features

Includes negotiated shipping rates in the shopping cart and on the checkout page.

Ability to control which UPS small packages services to display.

Provides quotes for shipments originating from the US or Canada and destined to any country UPS provides service to.

Define multiple warehouse and drop ship locations.

Compatible with the Standard Box Sizes plugin for hyper-accurate rate estimates supported by step-by-step graphic illustrations of the packaging solution.

Support for variable products.

Option to include residential delivery charge.

Compatible with the Residential Address Detection plugin which automatically includes the residential delivery fee in rate estimates when a residential address is detected.

Option to mark up shipping rates by a set dollar amount or by a percentage.

Works intelligently with Eniture Technology’s LTL Freight Quotes plugins to identify when orders should be quoted as parcel shipments and when they should be quoted as LTL freight shipments.

Current version: 1.1.1

Requirements

WooCommerce 3.0 or newer.

A UPS account number.

Your username and password to UPS.com.

Your UPS API Access Key.

FAQ’S

How do I get a UPS account number?

Contact them at 800-742-5877, or register online.

Where do I find my UPS.com username and password?

Contact UPS customer service at 800-742-5877 or the UPS account manager assigned to your account.

Where do I get my UPS API Access Key?

Obtaining a UPS API Access Key is done on UPS.com and requires a few steps. Refer to the Documentation tab on this page for detailed instructions.

How do I get a license key for the plugin?

You must register your installation of the plugin, regardless of whether you are taking advantage of the trial period or purchased a license outright. At the conclusion of the registration process an email will be sent to you that will include the license key. You can also login to eniture.com using the username and password you created during the registration process and retrieve the license key from the My Licenses tab.

How do I change my plugin license from the trial version to one of the paid subscriptions?

Login to eniture.com and navigate to the My Licenses tab. There you will be able to manage the licensing of all of your Eniture Technology plugins. Refer to the Documentation tab on this page for more thorough instructions.

How do I install the plugin on another website?

The plugin has a single site license. To use it on another website you will need to purchase an additional license. If you want to change the website with which the plugin is registered, login to eniture.com and navigate to the My Licenses tab. There you will be able to change the domain name that is associated with the license key.

Do I have to purchase a second license for my staging or development site?

No. Each license allows you to identify one domain for your production environment and one domain for your staging or development environment. The rate estimates returned in the staging environment will have the word “Sandbox” appended to them.

Why isn’t the plugin working on my other website?

If you can successfully test your credentials from the Connection page (WooCommerce > Settings > UPS > Connections) then you have one or more of the following licensing issues: 1) You are using the license key on more than one domain. The licenses are for single sites. You will need to purchase an additional license. 2) Your trial period has expired. 3) Your current license has expired and we have been unable to process your form of payment to renew it. Login to eniture.com and go to the My Licenses tab to resolve any of these issues.

Why were the shipment charges I received on the invoice from UPS different than what was quoted by the application?

The rates will be the same if the shipment parameters used to obtain the quote are exactly the same as those that were used for the invoice. Compare the shipment parameters in the application with those on the invoice. Pay close attention to product weight, dimensions and various accessorial fees like residential delivery. Consider making changes as needed. Remember that the weight of packaging materials is included in the weight of the shipment and that your use of box size may also have an impact on the shipment’s billable weight. If you are unable to reconcile the differences call UPS for assistance.

Why do I sometimes get a message that a shipping rate estimate couldn’t be provided?

There are several possibilities:

UPS has restrictions on a shipment’s maximum weight, length and girth which your shipment may have exceeded.

There wasn’t enough information about the weight or dimensions for the products in the shopping cart to retrieve a shipping rate estimate.

The city entered for the shipping address may not be valid for the postal code entered. A valid City+State+Postal Code combination is required to retrieve a rate estimate and Shopify does not perform this level of address validation. Contact us by phone (404-369-0680) or email (support@eniture.com) to inquire about solutions to this problem.

The UPS web service isn’t operational.

Your UPS account has been suspended or cancelled.

Your subscription to the application has expired because payment could not be processed.

There is an issue with the Eniture Technology servers.

There is an issue with your server(s).

Installation & User’s Guide

If you are taking advantage of a trial subscription, the plugin will stop working when the trial period ends. Be sure to read the Manage Your License section to learn how to upgrade your subscription.

Overview

Setting up the plugin consists of the following steps:

Other information contained in this guide:

1. Download the Installation File

Return to top.

Select a subscription package. You will be presented with a registration form. The email address and password you enter will serve as your credentials to eniture.com. Use these to gain access to your customer dashboard where you can download the plugin installation file, manage your licenses and update your payment information. When you download the plugin installation file, be sure to save it to a familiar location. You will need to navigate to the file during the installation process.

Note: If you obtained the plugin installation file from the WordPress Plugin Directory, you still need to select a subscription package and complete the registration form.

2. Install the Plugin Application File

Return to top.

Login to the WordPress dashboard as the website administrator.

In the left sidebar, hover your mouse over the Plugins menu to display the sub-menu options.

Select Add New from the sub-menu options. The Add Plugins page will load.

At the top of the Add Plugins page, click on the Upload Plugin button.

upload_plugin

Controls will appear in the middle of page that will allow you to chose and install the plugin application. Choose the Choose File button, navigate to the location where you saved the installation file and select it.

choose_file

Click the Install Now button.

WordPress will display information about the installation progress at the bottom of the page. The plugin has been installed once the message Plugin installed successfully is displayed.

3. Activate the Plugin

Return to top.

Once the plugin has been installed, it must be activated. If you are still on the same page that you were on at the end of Step 2, you can click the Activate Plugin link on the bottom of the page.

If you’ve already navigated away from that page, select Installed Plugins from the Plugins menu.

installed_plugins

Locate the Small Package Quotes – UPS Edition plugin on the list and click the Activate link.

4. Get Your UPS API Access Key

Return to top.

To successfully connect the app to UPS, in addition to a UPS account, and a username and password to UPS.com, you also need a UPS API Access key. If you don’t have one, sign into UPS.com and navigate to Services > Integrating UPS Technology. Click on the UPS Developer Kit tile.

On the UPS Developer Kit page, click on the Learn About Integrating UPS Developer Kit APIs button.

On the Developer Resource Center page, scroll down to the Step 3: Developers: Download APIs section and click on the Access the UPS Developer Kit link.

On the next page, click on the Request an access key link.

Complete the Request Access Key form, and then click the Request Access Key button at the bottom of the page.

You’ll be delivered to the Request Access Key – Confirmation page. It will contain your access key (arrow 1). Record the access key in a safe place. You will need it later. Also on the page will be a table containing a list of Developer Resources and their Access Type. You are interested in
Rating – Package (arrow 2).

If the access type is Production, you have completed this step in the documentation and can proceed to the next step.

If the access type is Test then the access key needs to be promoted to Production. To do so, navigate back to the UPS Developer Kit page and click on the Manage Access Keys link.

Enter your access key into the Request Production Access section and then click the Request Production Access button.

5. Configure the Plugin

Return to top.

Select Settings from the WooCommerce menu.

woocommerce_settings

Click on the FedEx tab to gain access to the plugin configuration settings.
Use the links at the top of the page to navigate between the Connection, Quote and Warehouse settings. Start with the Connection Settings.

5a. Connection Settings

Return to top.

Account Number Your UPS account number. If you don’t have one please contact UPS to obtain one.
Username The Username you use to sign into UPS.com.
Password The Password you use to sign into UPS.com.
API Access Key The UPS API Access Key obtained as a result of completing Step 4 of these instructions.
Plugin License Key The plugin license key is issued by Eniture Technology to registered users only. If you don’t have a plugin license key, click the link to the right of this field to obtain one.

When you’re done save your connection settings and then test them by clicking on the Test Connection button at the bottom of the page. A message will display at the top of the page letting you know if the plugin succeeded in establishing a connection to the UPS servers. If you receive an error, confirm the values you entered and try again. Be particularly attentive to capitalization. Most of the information you enter on this page is case sensitive.

5b. Quote Settings

Return to top.

Quote Service Options Place checkmarks next to the UPS domestic and international services you want to display in your shopping cart at checkout. For a description of the service guarantees for each option go to ups.com and retrieve the current year’s Service Guide.
Always quote as residential delivery When checked, the quotes returned quotes will include the residential delivery fee.
Auto-detect residential addresses Through the use of an addon plugin titled Residential Address Detection, Ship To addresses are checked against database records from the USPS. When the address is identified as residential, the residential delivery fee is included in the rate estimates. If the message “Click here to add the Residential Address Detection module.” is present, then the addon plugin is not installed. Click on the link to install it if you’d like to use this feature. (Learn more)
Auto-renew Displays only if the Residential Address Detection plugin is installed.
Choose a plan that best meets your needs. The credit card associated with quote plugin license will be billed immediately and the plan will become your current plan. Your choice will be retained for the auto-renew option. You can change your auto-renew selection at any time. Plans automatically renew at the end of every monthly billing cycle or upon the depletion of the current plan. To prevent a renewal, choose Disable from the list of options.
Current plan Displays only if the Residential Address Detection plugin is installed.
Displays information about the current plan and the start and end dates of the current subscription period.
Current usage Displays only if the Residential Address Detection plugin is installed.
Displays information about the consumption of the current plan. The date shown is the UTC timestamp of the last time a residential address detection event occured.
Suspend use Displays only if the Residential Address Detection plugin is installed.
Checking this box temporarily suspends the Residential Address Detection plugin. It does not permanently disable it and if the current monthly billing cycle expires, a new plan will be activated. To disable the plugin, deactivate it or choose Disable from the Auto-renew drop down.
Use my standard box sizes Through the use of an addon plugin titled Standard Box Sizes, you can define your standard box sizes which the plugin will use to identify the optimal packaging solution. The result is hyper-accurate shipping rate estimates. The packaging solution is saved as a step-by-step graphical illustration which is accessed from the Order Details page. If the message “Click here to add the Standard Box Sizes module.” is present, then the addon plugin is not installed. Click on the link to install it if you’d like to use this feature, or click (Learn more) to find out more information on this feature. If you have a Box Sizes option in the plugin navigation links, then you already have the addon plugin installed. Refer to Step 5d for instructions.
Hazardous Material Fee This amount will be added to the quotes returned by UPS if the product settings for one or more products identify it as a hazardous materials item. The fee is applied only once per shipment. If none of your products are deemed to be hazardous material, leave this field blank.
Handling Fee / Mark Up Increases the amount of each returned quote by a specified amount prior to displaying it/them in the shopping cart. The number entered will be interpreted as dollars and cents unless it is followed by a % sign. For example, entering 5.00 will cause $5.00 to be added to the quotes. Entering 5.00% will cause each quote to be multiplied by 1.05 (= 1 + 5%).
Allow other plugins to show quotes (Yes|No) Permit or prevent the display of shipping rates from other plugins.
Checkout options if the plugin fails to return a rate Choose how you want the cart to behave if the plugin fails to return shipping rates. You can allow the customer to complete the transaction, or prevent the customer from continuing. The text area below each option allows you to customize the message that will display in the cart.

5c. Define Warehouse and Drop Ship Locations

Return to top.

Click the Add button in the appropriate sections to add warehouse and drop ship locations. Warehouses should have a complete inventory of all products not otherwise identified as drop shipped items. If you have more than one warehouse defined, the warehouse closest to the shopper will be used to retrieve shipping rate estimates. You should define at least one warehouse, even if all of your products are drop shipped. This insures that quotes will be returned in the event the drop ship location was overlooked when the product entry was created.

Drop ship locations usually represent vendors that supply items that you don’t inventory. These items are shipped directly to your customer on your behalf. When an order includes drop shipped items the shopping cart will display a single figure for the shipping rate estimate that is equal to the sum of the cheapest option for each shipment required to fulfill the order.

5d. Enter standard box sizes

Return to top.

If your operation uses standard box sizes for fulfillment, you can achieve hyper-accurate shipping rate estimates by utilizing the Standard Box Sizes addon plugin. The packaging solution is saved as a step-by-step graphical illustration which is accessed from the Order Details page. If you have this plugin installed then you will have a Box Sizes option in the plugin navigation menu. If you don’t and would like to use this feature, click here to access a page where you can learn more and download the plugin installation file.

Below is an excerpt from the Standard Box Sizes User’s Guide to assist you with populating the associated settings. To view the full User’s Guide click here.

Auto-renew Choose a plan that best meets your needs. The credit card associated with quote plugin license will be billed immediately and the plan will become your current plan. Your choice will be retained for the auto-renew option. You can change your auto-renew selection at any time. Plans automatically renew at the end of every monthly billing cycle or upon the depletion of the current plan. To prevent a renewal, choose Disable from the list of options.
Current plan Displays information about the current plan and the start and end dates of the current subscription period.
Current usage Displays information about the consumption of the current plan. The date shown is the UTC timestamp of the last time a packaging solution was identified.
Suspend use Checking this box temporarily suspends the Standard Box Sizes plugin. It does not permanently disable the feature and if the current monthly billing cycle expires, a new plan will be activated. To disable the plugin, deactivate it or choose Disable from the Auto-renew drop down.

To add a box, click the Add Box button. A popup will display prompting you for the following information about the box:

Nickname Enter a nickname for the box. The nickname will be used to identify the box in the graphical illustration of the packaging solution.
Length The length of the box in inches.
Width The width of the box in inches.
Height The height of the box in inches.
Max Weight The maximum weight the box is rated to contain, entered as pounds.
Box Weight The weight of the box in pounds.
Available Check this box to make it available for the packaging solution calculations.

Below is a sample illustration of the step-by-step graphical illustration of a packaging solution accessible from the Order Details page.

If you elect not to use the Standard Box Sizes plugin, or it is disabled, the app will identify a packaging solution for the order by using a free built in algorithm that calculates virtual box sizes that are within the carrier’s service guidelines. The built in algrothim will be sufficient for some merchants, particularly those whose shipping charges are not determined by dimensional weight. (Learn more about dimensional weight)

6. Enable the Plugin (WooCommerce 3.0 or later only)

Return to top.

Select Settings from the WooCommerce menu.

woocommerce_settings

Click on the Shipping tab and select the option for Shipping Zones.

The shipping method needs to be added to a shipping zone. If an appropriate shipping zone isn’t already defined, click the Add shipping zone button and define one.

Now add the shipping method to the zone. Click on the “+” inline with the shipping zone…

…select the UPS option from the drop down list of shipping methods…

…and click on the Add shipping method button.

Repeat this process for each shipping zone you want to the app to return quotes for. You should test each zone to make sure the geography defined by the shipping zone is supported by the app.

The app will return rates for the following types of shipments:

  • – US domestic shipments
  • – Canadian domestic shipments
  • – Shipments from the United States to Canada
  • – Shipments from Canada to the United States
  • – Shipments from the US to countries serviced by UPS

7. Product Settings

Return to top.

The products you intend to sell and ship should have their shipping weight and dimensions recorded. Your shipping rate is based on the billable weight of the shipment, which is equal to the greater of the shipment’s actual weight or dimensional weight. The omission of weight or dimensions, or inaccuracies in the values of either, will impact the accuracy of the shipping rates displayed in the shopping cart. To learn more about determining the billable weight of a shipment refer to the current year’s service guidelines at fedex.com.

To record the weight and dimensions of a product, navigate to your product list in the WordPress Dashboard by selecting Products from the Products menu.

products_products

Select the product you want to update. Once you’re on the Edit Product page, locate the Product Data region and click on the Shipping option to access the product’s shipping characteristics.

Weight Enter the weight of the product in pounds.
Dimensions Enter the dimensions of the product in inches.
Shipping Class If you have the Small Package Quotes plugin installed and you wish the product quoted as shipping parcel, select the No shipping class option.

If you have the LTL Freight Quotes plugin installed and you wish the product quoted as shipping LTL freight, select the LTL Freight option.

Freight Classification This option will only be visible if the LTL Freight Quotes plugin is installed.

Select the freight class for the product from the list of options. If you utilize both small package (parcel) and LTL freight shipping methods, you should identify the freight class for all products, even those that normally ship small package (parcel).

The last option in the list of freight classifications is Density Based. In most cases this is an industry accepted alternative for identifying the freight class of an item or shipment. Validate the returned quotes if using this setting. There are exceptions in the NMFC Freight Classification Directory that can render the density calculator results invalid for particular commodities. To be used successfully the product must have its weight and dimensions populated in the Shipping sub-panel.

Enable Drop Ship Location This option will only be visible if there are drop ship locations defined. Refer to step 5c: Define Warehouse and Drop Ship Locations for instructions on how to define drop ship locations.

Check this box if this product ships from a drop ship location.

Drop Ship Location This option will only be visible if there are drop ship locations defined. Refer to step 5c. Define Warehouse and Drop Ship Locations for instruction on how to define drop ship locations.

If the product is drop shipped, select the drop ship location from the list of options.

Allow vertical rotation This option will only be visible if Standard Box Sizes plugin is installed. Refer to step 5d. Enter standard box sizes for instructions on how to define drop ship locations.

Enabling this setting allows the item to be rotated while identifying a packaging solution involving standard box sizes. This setting provides the most flexibility for arriving at a packaging solution.

Ship as own package This option will only be visible if Standard Box Sizes plugin is installed. Refer to step 5d. Enter standard box sizes for instructions on how to define drop ship locations.

Enabling this setting prevents the item from being combined with other items into one of the standard box sizes. The item will be included in the shipment as its own package with the weight and dimensions specified.

If your product is a Variable Product, be sure to set the weight and dimensions for each product variation on the Variations page.

When you are done click the Update button located in the Publish widget located at the top right of the page.

What Your Customer Sees

Return to top.

To facilitate the successful conclusion of an online purchase the plugin always attempts to return an estimate of shipping charges. If multiple products are in the shopping cart and some are missing weight, dimensions or both, the plugin will use what is available to obtain the shipping rate estimates. For example, if you have two products in the shopping cart and the first has weight and dimensions and the second does not, the shipping rate estimate will be based solely on the first product. The plugin will fail to return shipping rate estimates only when none of the products in the shopping cart have weights or dimensions recorded. Please note shipping rate estimates will be increasingly inaccurate the more omissions there are to the weight and dimensions of products in the shopping cart.

The shopping cart won’t display shipping rate estimates the first time the shopper views the shopping cart because it isn’t aware of the ship to address. The user will be prompted to click on the Calculate Shipping Cost link to provide this information.

Appearance of shopping cart when viewed by a shopper who is not logged in to the website. Appearance of the shopping cart after the user clicks on the Calculate Shipping link.
cart_1 cart_2

After the user provides the ship to information, the shopping cart will display the shipping rate estimates based on the settings entered in for the plugin.

Appearance of shopping cart when viewed immediately after the ship to information is provided. Not all of the available UPS service options shown.

If the plugin is unable to display shipping rate estimates, the shopper will be directed to call in for a quote. Typical reasons why quotes may not be displayed include: 1) Insufficient data on the products in the shopping cart, such as weight or dimensions; 2) Invalid credentials due to a password change, an expired license, or a suspended FedEx account; 3) An invalid or incomplete ship to address was provided; or 4) The carrier’s web service is not operational.

Appearance of shopping cart when the plugin is unable to display shipping rate estimates.
cart_5_speedship

Managing Your License

Return to top.

You can manage your license by signing into eniture.com with the email address and password you entered when you registered for the plugin. After you sign in, My Account will be added to the navigation menu. Click on it to access the Dashboard for your account.

my_account

The most common uses of the Dashboard are to upgrade a trial subscription to a paid subscription, change the URL registered to a license, or to identify the URL of a staging or development site.

Upgrade to a paid subscription

If you fail to upgrade your trial subscription to a paid subscription before the trial expires, the plugin will stop working. To upgrade, click on the My Licenses tab, locate the license, and click the Pay Now button.

Choose one of the subscription packages and then enter the information for your payment method. Your plugin will be automatically renewed at the end of each subscription period unless you return to the Dashboard and cancel the subscription.

Change the URL registered to a license

The plugin license allows you to use the plugin on a single website. To use the plugin on additional websites, you must purchase additional licenses. You can change the URL registered on a license at any time. To do so, click on the My Licenses tab, locate the license, and click the Edit button. Enter the new URL into the Licensed Domain field and then click the Update button.

licensed_domain

Identify a staging or development site

The plugin license will allow one staging or development site. Quotes returned to this site will have the word “Sandbox” appended to them. To identify a staging site, click on the My Licenses tab, locate the license, and click the Edit button. Enter the new URL into the Staging Domain field and then click the Update button.

staging_domain