Small Package Quotes

UPS Edition for WooCommerce

The UPS Small Package Quotes plugin retrieves your negotiated parcel rates, takes action on them according to the plugin settings, and displays the results as shipping options in the WooCommerce cart and checkout page. 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.

Basic Plan

Live negotiated rates displayed in the cart and checkout page.

Supported origins: Canada, United States

Supported destinations: Any country to which UPS provides service.

Choose which UPS services to offer to your shoppers.

Mark up individual UPS services by dollar amount or percentage.

Option to always include the residential delivery fee.

Identify one warehouse and multiple drop ship locations.

Compatible with the Residential Address Detection plugin which automatically includes the residential address delivery fee when the Ship To address is a residence. (US addresses only.)

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

Embed a handling charge in the displayed rates to recover the cost of packaging materials or other shipping related expenses.

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.

Standard Plan

Everything in the Basic Plan, plus…

Define multiple warehouses.

The warehouse closest to the shopper is used as the shipment origin to keep shipping costs low and delivery times fast.

Option for quotes to include the Declared Value (Insurance) premium.

Support for products that ship as hazardous material.

Advanced Plan

Everything in the Standard Plan, plus…

Use transit time to limit when Ground service is offered.

Offer in-store pick up based on the shopper’s ZIP code or distance to the warehouse.

Offer local delivery based on the shopper’s ZIP code or distance to the warehouse.

Identify a charge for local delivery.

Support for products that can be nested when shipped, such as garbage cans or drinking cups.

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. Connection Settings

Return to top.

Select Settings from the WooCommerce menu.

woocommerce_settings

Click on the UPS 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.

Account NumberYour UPS account number. If you don’t have one please contact UPS to obtain one.
UsernameThe Username you use to sign into UPS.com.
PasswordThe Password you use to sign into UPS.com.
API Access KeyThe UPS API Access Key obtained as a result of completing Step 4 of these instructions.
Plugin License KeyThe 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.

The plugin’s License Key will be tied to a subscription. The Trial Plan will give you 15 days of free access to the Basic Plan. Two other plans are available; the Standard Plan and the Advanced Plan. The features associated with each plan are listed on the Features tab of this web page. Each plan is available for a monthly or yearly subscription rate. To manage your License Key, including which plan is associated with it, see the section titled Managing your license. at the end of this User’s Guide.

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.

6. Quote Settings

Return to top.

If you don’t have visibility to the plugin’s navigation menu, select Settings from the WooCommerce menu.

woocommerce_settings

Click on the UPS tab to gain access to the plugin configuration settings. Using the links at the top of the page, select Quote Settings.

WooCommerce UPS Small Package Quotes plugin settings

Quote Service OptionsPlace checkmarks next to the UPS domestic, international and contract 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. You must have an agreement in place with UPS to use the Contract Services.

Beneath each service is a markup field. You can enter a dollar amount (e.g. 5.00) or percentage (e.g. 3.5%) in the field if you’d like to mark up the rate returned for that service. You can also enter a negative value if you want to mark down the rate. Later in the Quote Settings there is a general Handling Fee / Mark Up field that will be applied to all returned rate estimates. The service level markups are applied before the general setting.

Don’t sort shipping methods by priceBy default, the plugin will sort all shipping methods by price in ascending order. Check this box to disable this behavior. When checked, shipping methods will be ordered in the order they are listed in the WooCommerce Shipping Zones settings.
Always quote as residential deliveryWhen checked, the quotes returned quotes will include the residential delivery fee.
Auto-detect residential addressesThrough 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-renewDisplays 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 planDisplays 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 usageDisplays 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 useDisplays 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.
Default unconfirmed address types to:Displays only if the Residential Address Detection plugin is installed.
Select Residential or Commercial. In rare cases the plugin my be unable to confirm the address type. This occurs when a match for the address can’t be found in the USPS database. Invalid addresses are the most common reason for this. In extremely rare cases an address may be valid, but the match found in the USPS database has a low confidence metric. Choose how you want addresses treated in these cases.
Use my standard box sizesThrough 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 add on 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 add on plugin installed. Refer to Step 8 for instructions.
Ground transit time restrictionsThe Advanced Plan is required to use this feature. If you aren’t on the Advanced Plan the words Advanced plan required will be displayed. Click on the Advanced plan required text to upgrade your plan and gain access to the feature.

This feature is commonly used by merchants who sell perishable products and need to prevent Ground service from displaying as an option when the shipment transit time exceeds a certain number of days.

In the box provided, enter the maximum number days your products can be in transit. Leave blank to disable this feature.

Pick the option to Restrict by the carrier’s in transit days metric to apply the rule based on the carrier’s in transit days estimate. Carriers identify the in transit days as business days. Choose this option if you hold orders until a ship date occurs upon which the order can be shipped and not be delayed by weekends or holidays.

Pick the option to Restrict by the calendar days in transit if you want to include weekends and holidays when determining if Ground service will be displayed. Choose this option if you always ship orders at the first opportunity to do so.

Only quote ground service for hazardous materials shipmentsThe Standard Plan or higher is required to use this feature. If you aren’t on the Standard Plan or higher the words Standard plan required will be displayed. Click on the Standard plan required text to upgrade your plan and gain access to the feature.

Check this box if you only want ground service quoted in the event that one or more of the products in the shopping cart is identified as hazardous material.

Ground Hazardous Material FeeThe Standard Plan or higher is required to use this feature. If you aren’t on the Standard Plan or higher the words Standard plan required will be displayed. Click on the Standard plan required text to upgrade your plan and gain access to the feature.

Enter in the amount that should be added to the ground rate estimate in the event that one or more of the products in the shopping cart is identified as hazardous material. The fee will only be added once per shipment.

Air Hazardous Material FeeThe Standard Plan or higher is required to use this feature. If you aren’t on the Standard Plan or higher the words Standard plan required will be displayed. Click on the Standard plan required text to upgrade your plan and gain access to the feature.

Enter in the amount that should be added to the air service estimates in the event that one or more of the products in the shopping cart is identified as hazardous material. The fee will only be added once per shipment. A special agreement/contract may be required to use air services to ship hazardous materials.

Handling Fee / Mark UpIncreases 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 rateChoose 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.

7. Define Warehouse and Drop Ship Locations

Return to top.

If you don’t have visibility to the plugin’s navigation menu, select Settings from the WooCommerce menu.

woocommerce_settings

Click on the UPS tab to gain access to the plugin configuration settings. Using the links at the top of the page, select Warehouses.

Click the Add button in the appropriate sections to add warehouse and drop ship locations. On the Basic Plan you can define one warehouse and multiple drop ship locations. To define multiple warehouse locations you must be on the Standard Plan or higher.

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.

7a. In-store pick up settings

Return to top.

The Advanced Plan is required to use this feature. If you aren’t on the Advanced Plan the words Advanced plan required will appear adjacent to the settings header, and the fields associated with the feature will be inaccessible.

In-store pick up can be offered as an option in the checkout process based the shopper’s postal code or proximity. It will only be offered if the feature is enabled and only one stocking location (warehouse or drop ship location) is involved in providing a quote. The settings for In-store pick up are visible on the page used to add or edit a warehouse or drop ship location.

Enable in-store pick upCheck the box to enable the in-store pick up feature.
Offer if address is within (miles)The distance in miles within which you’d like to offer in-store pick up. The distance is route miles (driving distance). Leave blank if you don’t want to use distance to determine if in-store pick up should be offered. If both distance and postal codes are used as evaluation criteria, in-store pick up will display if either is satisfied.
Offer if postal code matchesThe postal codes to which you’d like to offer in-store pick up. Enter only the five digit ZIP Code for US addresses. Leave blank if you don’t want to use postal codes to determine if in-store pick up should be offered. If both distance and postal codes are used as evaluation criteria, in-store pick up will display if either is satisfied.
Checkout descriptionThe description to use to identify the option in the checkout process. The most obvious candidate is In-store pick up, but you can make it anything you’d like.

7b. Local delivery settings

Return to top.

The Advanced Plan is required to use this feature. If you aren’t on the Advanced Plan the words Advanced plan required will appear adjacent to the settings header, and the fields associated with the feature will be inaccessible.

Local delivery can be offered as an option in the checkout process based the shopper’s postal code or proximity. It will only be offered if the feature is enabled and only one stocking location (warehouse or drop ship location) is involved in providing a quote. Local delivery can display as a free option or have a charge associated with it. Other shipping options provided by the app can be suppressed when local delivery is to be offered. The settings for Local delivery are visible on the page used to add or edit a warehouse or drop ship location.

Enable local deliveryCheck the box to enable the local delivery feature.
Offer if address is within (miles)The distance in miles within which you’d like to offer local delivery. The distance is route miles (driving distance). Leave blank if you don’t want to use distance to determine if local delivery should be offered. If both distance and postal codes are used as evaluation criteria, local delivery will display if either is satisfied.
Offer if postal code matchesThe postal codes to which you’d like to offer local delivery. Enter only the five digit ZIP Code for US addresses. Leave blank if you don’t want to use postal codes to determine if local delivery should be offered. If both distance and postal codes are used as evaluation criteria, local delivery will display if either is satisfied.
Checkout descriptionThe description to use to identify the option in the checkout process. The most obvious candidate is Local delivery, but you can make it anything you’d like.
Local delivery feeEnter the amount to charge for local delivery. Leave blank to offer local delivery for free.
Suppress other ratesCheck the box to show only the option for local delivery when the criteria for doing so (distance or postal code) is met. Leave unchecked to have local delivery offered in addition to the shipping options normally displayed by the app.

8. 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 add-on plugin.

The plugin will identify the best box(es) to use for the order and include the packaging solution when requesting rates from the carrier. The packaging solution is saved as a step-by-step graphical illustration which you can access from the Order Details page. Use the step-by-step instructions to pack the order exactly as it was quoted.

Illustration of a packaging solution

If you have the Standard Box Sizes plugin installed, Box Sizes will appear as an option in the plugin navigation menu. If it doesn’t and you want to use this feature, go to the Standard Box Sizes product page where you can learn more and download the plugin installation file.

WooCommerce Standard Box Sizes Menu

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 using a free built in algorithm that calculates virtual box sizes that are within the carrier’s service guidelines. The built in algorithm will be sufficient for some merchants, particularly those whose shipping charges are not affected by dimensional weight rules.

Dimensional weight is an extremely important factor when calculating rates for parcel services. Have a clear understanding of the topic when deciding whether or not to use the Standard Box Sizes plugin. (Learn more about dimensional weight)

If you don’t have visibility to the plugin’s navigation menu, select Settings from the WooCommerce menu.

woocommerce_settings

Click on the UPS tab to gain access to the plugin configuration settings. Using the links at the top of the page, select Box Sizes.

Box sizes settings

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

Auto-renewChoose 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 planDisplays information about the current plan and the start and end dates of the current subscription period.
Current usageDisplays 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 useChecking 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:

NicknameEnter a nickname for the box. The nickname will be used to identify the box in the graphical illustration of the packaging solution.
Box TypeChoose a box type from the drop-down list. Choose Merchant defined box for boxes you purchase from a supplier like Uline. If the box came from a carrier (e.g., FedEx, UPS, USPS), choose the entry that most accurately describes it. Packaging solutions that use carrier sourced boxes are available only for the services offered by that carrier. Boxes intended for specific service offerings, such as flat rate shipping, are restricted to those services.
LengthThe length of the box in inches.
WidthThe width of the box in inches.
HeightThe height of the box in inches.
Max WeightThe maximum weight the box is rated to contain, entered as pounds.
Box WeightThe weight of the box in pounds.
Box FeeEnter the amount you want to charge, if any, for the box when it is used in the packaging solution. The amount will be included in the shipping quote.
AvailableCheck this box to make it available for the packaging solution calculations.

9. 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

10. 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 this year’s service guidelines at ups.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.