WooCommerce

WooCommerce Integration Requirements

Connection Requirements:

You must have a live WooCommerce store with permalinks set correctly. Learn more about setting up permalinks in WordPress.

If your WooCommerce store is not active, you may get a 404 error when attempting to connect to ShippingEasy.
ShippingEasy supports WooCommerce version 3.0.x or higher, which requires WordPress version 4.4 or higher. If you are using an older version of WooCommerce, please see our guide to using the ShipEngine Legacy Plugin for WooCommerce.
The WooCommerce REST API must be enabled for your store. Learn more about generating your WooCommerce REST API keys.

Determine your WooCommerce version:

Log into your WordPress website as an administrator.
Go to Plugins > Installed Plugins, then scroll to the WooCommerce plugin.

The version of WooCommerce that you have installed will be located in the description of the plugin.

Determine your WordPress version:

Log into your WordPress website as an administrator.
Click on the WordPress W symbol in the upper-left corner, then click About WordPress. Your WordPress version will be listed on this page.

SSL for Your WooCommerce Website

ShippingEasy HIGHLY recommends configuring your WooCommerce website for SSL (i.e., HTTPS connections) for both security and reliability. Learn more about setting up SSL for your WooCommerce website.

If you have SSL on your site, make sure the URL is https://www.myshop.com instead of http://www.myshop.com.
If your site is at https://www.example.com, make sure you haven’t entered https://example.com without the "www" in the URL.

Order Import Requirements:

Orders placed in the last 14 days will appear on the ORDERS page in ShippingEasy.

If you have orders older than 14 days, you can create manual orders for these shipments. Learn more about creating manual orders.
Make sure you have not set up your WooCommerce store to automatically mark your orders as Fulfilled. Learn more about the WooCommerce Order Status Control plugin.

Connect a WooCommerce Store to ShippingEasy

How to connect your WooCommerce to an existing ShippingEasy account

Go to SETTINGS and click on the STORES & ORDERS page under the INTEGRATION section.
Click on the + Add New button on the side of the screen.
Select WooCommerce from the Platform drop-down menu. You will then see one additional field: Store URL.
Copy and paste the URL for your WooCommerce store into the Store URL field.

Entering Your WooCommerce URL

The WooCommerce store URL that you enter into ShippingEasy should be the root URL to your WordPress installation. In most cases, this will be something like http://www.myshop.com/.

Sometimes the whole WordPress installation is installed in a subdirectory, so the URL might be something like http://www.myshop.com/wp/ or http://www.myshop.com/wordpress/.

Visit the WordPress dashboard Settings > General page and make sure that the WordPress Address URL matches WooCommerce Store URL you are using in ShippingEasy.
Click Save.
On the next screen, you will be prompted to enter your username and password for your WooCommerce store so that ShippingEasy can connect to it and request the necessary permissions. Enter your login credentials, then click Login.
After logging into your account, you will be prompted to give ShippingEasy access to your store, which is necessary for managing your store orders. Click Approve.
After ShippingEasy is granted access to your store, you will be returned to your store settings page in ShippingEasy where you can enter information about your store.

Click the Save button at the bottom of the store settings page.

That's it! Your store is connected to ShippingEasy!

WooCommerce Order Data

WooCommerce Standard Data Supported

ShippingEasy's WooCommerce integration supports the following features and order data fields:

Common Integration Features

Feature	Supported?
Custom Statuses
Customer Emails
Customer Phone Numbers
Requested Service
Payment Method
Discounts
Identifies Gift Orders
Internal Notes
Customer Notes
Combine Orders
Split Orders

Feature	Supported
Item Name
Item Weight
Product Options
Item Warehouse Location
SKU

Field	Supported?
Ship Date
Status Update
Tracking Number
Carrier
Service
Carrier Fee
Note to Buyer
Item Information

Notes on Standard Data Supported for WooCommerce orders:

WooCommerce coupon codes will be listed in the Customer Comment section of the order in ShippingEasy.
When a WooCommerce order is shipped through ShippingEasy, the tracking number will be sent to WooCommerce as an Order Note. The order will then be updated to the Fulfilled status in WooCommerce.

This is done to ensure shipment notifications are sent from WooCommerce directly, include the tracking information.

Supported Order Statuses

WooCommerce order statuses map to ShippingEasy in the following way:

WooCommerce Status	ShippingEasy Status
Pending	Awaiting Shipment
Processing	Awaiting Shipment
On-Hold	Awaiting Shipment
Custom 1, 2, 3	Awaiting Shipment

ShippingEasy will sync Pending, Processing, and On-Hold WooCommerce orders by default. However, you have the flexibility to configure which order statuses get synced, including custom orders statuses, within your WooCommerce store settings. Learn more about selecting WooCommerce order statuses to sync to ShippingEasy.

Import WooCommerce Orders with Custom Statuses

The WooCommerce Order Status Manager plugin allows you to create, edit, and delete custom order statuses and integrate them seamlessly into your order management flow.

If you create custom order statuses that you want ShippingEasy to sync to the ORDERS page, you will need to configure the order status in the Order Status Manager plugin, so it maps to one of the three custom order statuses (custom_1, custom_2, and custom_3) in your ShippingEasy WooCommerce Store Settings.

Configure ShippingEasy to Import Orders with Custom Order Statuses:

Log into your WordPress site administrator dashboard.
Select Settings in the WooCommerce menu.
Click on the Order Statuses tab.
Click on the name of the custom order status you want ShippingEasy to also sync to the ShippingEasy ORDERS page.
Configure the Slug name for the custom order status to match one of the three ShippingEasy custom status names. We use custom_1 in this example.

Click the Save Order Status button to save your changed Slug.
Return to ShippingEasy and navigate to SETTINGS > INTEGRATION > STORES & ORDERS.
Click Edit store settings for your WooCommerce store.
Click the Orders tab in the store settings. Check the box next to the matching custom order status.
Click the Save button at the bottom of the page.

ShippingEasy will now import orders from your WooCommerce store that have the matching custom order status.

Troubleshoot WooCommerce Orders and Shipments

Syncing Orders

ShippingEasy queries your WooCommerce store on a recurring basis to find any new orders that need to be downloaded.

If your WooCommerce orders are not being sent to ShippingEasy, there are a few common causes.

Is the connection to your server timing out?

Since WooCommerce stores are self-hosted, it's important to check that your server speed is fast enough. Slow sites may cause connections to time out. ShippingEasy may not be able to download orders if the speed is slower than 200 ms. Check your site speed.
Does the order have a shipping address?

ShippingEasy requires that orders have a shipping address to sync. Check the order in WooCommerce to see if there is both a 'billing' and 'shipping' address.

If the 'shipping' address is missing, double-check how your shopping cart is configured to ensure that information is captured on orders that need to be shipped.
Are you using the JetPack plugin?

If you are using JetPack with WooCommerce, you will need to publicize the plugin to resolve issues with order syncing. Follow these steps to publicize your JetPack plugin.

Updating Shipped Orders

When shipping WooCommerce orders through ShippingEasy, the order status is updated after a label is printed.

If you notice that your orders are not updating in WooCommerce to Fulfilled or Complete after the label has been printed and at least one hour has elapsed, this could be caused by your store's callback path.

If you do not use permalinks for your WooCommerce store, updating your store's callback path can resolve shipment update errors.

How to update a WooCommerce callback path in ShippingEasy

Navigate to your STORES & ORDERS page.
Find your WooCommerce store and click Edit store settings.
Look at the callback URL under Shipment Callback Path. Change the default Shipment Callback Path from /shipment/callback to: ?shipment=1&callback=1
Click Save to confirm your changes.
Navigate to your SHIPMENT HISTORY page.
Select the orders you want to update all at once by checking the boxes to the left of the orders.
Click the drop-down next to the Resend/Retry button at the top of the page. Select the Retry Store Order Updates option. This will send a new shipment update to WooCommerce.
Verify in WooCommerce that the order status has been correctly updated.

Incorrect Order Weights

If your order weights in ShippingEasy do not match what is in your WooCommerce store, double-check the weight settings in both ShippingEasy and WooCommerce.

For example, WooCommerce accounts with product weights in pounds may sync incorrectly if product weights are set to ounces in your ShippingEasy STORES & ORDERS settings for your WooCommerce store.

Learn more about editing your product weights in WooCommerce.

How to verify your ShippingEasy weight settings

Navigate to your STORES & ORDERS page.
Find your WooCommerce store and click Edit store settings.
Go to the Products tab. Locate the drop-down menu under Weight Measurement. Verify that the unit of measurement matches your product weight unit in WooCommerce > Settings > Products.
Click Save to confirm any changes.

WooCommerce Integration Notes

Editing Orders and Shipments

If you create a duplicate shipment from SHIPMENT HISTORY in ShippingEasy, the tracking number will NOT update in WooCommerce.
If you change the recipient address for an order in WooCommerce, that change will update in ShippingEasy during each automatic sync once per hour or via a manual sync. Learn more about order changes that sync in ShippingEasy.

Orders will NOT update if:
- The order is moved from the ORDERS page and later returned. Orders must remain on the ORDERS page to receive updates via the API during automatic sync.
- If you manually adjust an order in ShippingEasy (add a line item, remove a line item, edit the address, etc.). We consider ShippingEasy to be the main source of information and will not check for updates within WooCommerce on future store syncs.
If you cancel an order in WooCommerce, the order will be removed from ShippingEasy during the next sync as long as the order has not been removed from the ORDERS page.
If the line items of a WooCommerce order are changed in any way in ShippingEasy, then ShippingEasy will NOT specify any line item information when sending the shipment information back to WooCommerce. This will cause WooCommerce to mark the entire order as Fulfilled.

So, if you change the quantity of a line item in ShippingEasy, or add a line item, or remove a line item, ALL line items will be marked as Fulfilled in WooCommerce after you create a shipment for that order in ShippingEasy.

If you split a WooCommerce order in ShippingEasy, WooCommerce will show the correct fulfillment status of each line item as long as you do not edit the line items in ShippingEasy.

Combining and Splitting Orders

When two WooCommerce orders are combined in ShippingEasy, both orders will NOT be updated in WooCommerce.

There is a surviving and non-surviving order number. When the combined order is shipped:
- The non-surviving order number WILL update in WooCommerce.
- The surviving order number will NOT update in WooCommerce.
The surviving order cannot be updated because it contains too many line items (the line items for both of the orders), and not all of the items are actually in the order in WooCommerce. This returns an error from WooCommerce, and ShippingEasy flags the order as unable to be updated. Learn more about filtering shipments that have failed to update to the store.
If you split a WooCommerce order in ShippingEasy, then ShippingEasy will update both tracking numbers to WooCommerce.

However, WooCommerce does not have a "partially shipped" order status, which means the order status will update to Complete when the first shipment notification for the split order is sent to WooCommerce.

Subsequent shipments for the split order will post the associated shipment information (e.g., tracking number) to the WooCommerce order.

Email Notifications

WooCommerce automatically sends shipment confirmation emails to your customer IF you have version 1.5 or higher of the WooCommerce Shipment Tracking plugin.

If you opt to also send shipment confirmation emails from ShippingEasy, your customers will receive two emails. Learn more about sending emails from ShippingEasy.

${data.category.name}