Shipment Tracking

The Shipment Tracking extension provides customers with an easy way to track shipments by adding a link to emails and order pages.

Allows you to add shipment tracking to emails sent to the customer (e.g., Completed Order email).

Installation ↑ Back to top

  1. Download the .zip file from your WooCommerce account.
  2. Go to: WordPress Admin > Plugins > Add New and Upload Plugin with the file you downloaded with Choose File.
  3. Install Now and Activate the extension.

Adding tracking information to orders ↑ Back to top

Note: Shipment tracking details are added to the “completed order” email once the order status is marked as completed.

On the edit/view order screen, you will see a new write panel for shipment information:

Adding Order Shipment Tracking
Adding Order Shipment Tracking

To add shipment information for the customer to view:

Shipment Tracking Details
Shipment Tracking Details
  1. Choose a provider. This should be the shipping company you use. If your provider is not listed, choose the Custom Provider option.
  2. Add the tracking number that the provider assigned. If you chose the custom option, you need to enter the full link to the company’s tracking page (if applicable).
  3. Choose a shipping date (optional), which is when the package was shipped.
  4. (optional) Test the preview link to see if it works as you expect.
  5. Save tracking. This is also a good time to change the order status to Complete. Marking the order as Complete will send the Completed Order email to the customer, including the shipment tracking code.
  6. (optional) Add additional tracking numbers by clicking Add Tracking Number.
Completed Order email with tracking details and link

Custom Meta Reference ↑ Back to top

The Shipping Tracking plugin stores the tracking information in the order meta with the meta key _wc_shipment_tracking_items. It’s an array with the following structure:

  • tracking_provider — String of predefined provider
  • custom_tracking_provider — String of custom provider
  • custom_tracking_link — String of custom tracking URL
  • tracking_number — String of tracking number
  • date_shipped — Timestamp of shipment date

Developers can use the helper function wc_st_add_tracking_number to add tracking info to an order. In this helper function the field $custom_url is optional.
Example usage:

Customization ↑ Back to top

Changing the default shipment provider ↑ Back to top

Note: This is a Developer level section. If you are unfamiliar with code and resolving potential conflicts, select a WooExpert or Developer for assistance. We are unable to provide support for customizations under our  Support Policy.

The plugin provides a hook for changing the default provider from ‘custom’ called ‘woocommerce_shipment_tracking_default_provider’. This can be used by adding a custom function to your theme functions.php file and passing back the name of the provider, which should be the default:

Add Custom Providers Dynamically ↑ Back to top

You can add custom providers dynamically by using this snippet in functions.php in your theme folder:

Hide Unused Shipping Providers ↑ Back to top

You can hide the shipping providers you will not use with this snippet. Note: this code will remove ALL shipping providers. Remove the ones you want to appear before using. For example, if you want to use FedEx, then delete line 23.

REST API Support ↑ Back to top

Version 1.5+ support the REST API

Questions and Feedback ↑ Back to top

Have a question before you buy? Please fill out this pre-sales form.

Already purchased and need some assistance? Get in touch with a Happiness Engineer via the Help Desk.

WooCommerce - the most customizable eCommerce platform for building your online business.

Back to the top