Pro plugin Version 1.2.3 Updated

Dispatchio - Advanced Shipment Tracking for WooCommerce documentation

Complete fulfillment manager for WooCommerce: unlimited tracking numbers, 59 built-in carriers, custom order statuses (Shipped, Partially Shipped, Delivered), branded shipment emails, CSV and FTP import, PayPal and Stripe tracking sync, shipment analytics and a branded customer tracking page…

Try the live demo Get Dispatchio

Overview

Complete fulfillment manager for WooCommerce: unlimited tracking numbers, 59 built-in carriers, custom order statuses (Shipped, Partially Shipped, Delivered), branded shipment emails, CSV and FTP import, PayPal and Stripe tracking sync, shipment analytics and a branded customer tracking page…

Requirements

  • WordPress 6.2 or later
  • PHP 7.4 or later
  • WooCommerce 5.2 or later
  • Required plugins: woocommerce

Installation

Download Dispatchio - Advanced Shipment Tracking for WooCommerce from your ProPluginsLab account, then upload it to WordPress.

  1. Log in to your ProPluginsLab account and open My Account > Downloads.

  2. Download the plugin zip file.

  3. In your WordPress admin, go to Plugins > Add New Plugin > Upload Plugin.

  4. Choose the zip file, click Install Now, then Activate.

License and automatic updates

Dispatchio works fully as soon as it is activated. The license key turns on automatic updates, so new versions arrive in WordPress like any other plugin update. Pro features never depend on it.

Activate your license

  1. Find your license key in My Account on propluginslab.io, in the license keys section. It is also in your order confirmation email.

  2. In WordPress, open Dispatchio > License. When two or more ProPluginsLab plugins or add-ons are active on the site, WooCommerce > Licenses also appears and lists all of them in one place.

  3. Paste the key into the Dispatchio - Advanced Shipment Tracking for WooCommerce Pro row and click Activate. The status changes to Active and automatic updates are on.

The license screen with a license key field, an Activate button and the license status
Dispatchio > License: paste the key and click Activate.

Receive updates automatically

Once the license is active, new versions of Dispatchio show up under Dashboard > Updates and on the Plugins screen. Click Update now, or click Enable auto-updates in the Dispatchio row on the Plugins screen and WordPress installs every future release for you.

Good to know

  • Keys are checked once a day in the background, so your site never waits for the license server. If the server is briefly unreachable, the plugin keeps its last known status.
  • An expired key or a key that is not accepted only stops updates. Dispatchio keeps working. After renewing, click Check now in its row.
  • Moving to a new domain: click Deactivate on the old site first, then activate the key on the new one. The status shows Site address changed, checking until the new address is confirmed.
  • On the command line: wp ppl-license list, wp ppl-license activate <plugin> <key>, wp ppl-license check and wp ppl-license deactivate <plugin>.

Quick start

  1. Open Fulfillment Dashboard

    Go to wp-admin/admin.php?page=dispatchio in your WordPress admin.

  2. Open Shipment Analytics

    Go to wp-admin/admin.php?page=dispatchio-analytics in your WordPress admin.

  3. Open Dispatchio Shipment Tracking

    Go to wp-admin/admin.php?page=dispatchio-settings&tab=carriers in your WordPress admin.

  4. Open Dispatchio Advanced Shipment Tracking for WooCommerce Pro License

    Go to wp-admin/admin.php?page=cwg-license-dispatchio-shipment-tracking-for-woocommerce-pro in your WordPress admin.

#Fulfillment Dashboard

Location: wp-admin/admin.php?page=dispatchio

On this screen:

  • Fulfillment Dashboard
Screenshot: Fulfillment Dashboard
Fulfillment Dashboard

#Shipment Analytics

Location: wp-admin/admin.php?page=dispatchio-analytics

On this screen:

  • Shipment Analytics
  • Shipments per carrier
  • Shipments per day
  • Tracking source
Screenshot: Shipment Analytics
Shipment Analytics

#Dispatchio Shipment Tracking

Location: wp-admin/admin.php?page=dispatchio-settings&tab=carriers

On this screen:

  • Dispatchio Shipment Tracking
Screenshot: Dispatchio Shipment Tracking
Dispatchio Shipment Tracking

#Dispatchio Advanced Shipment Tracking for WooCommerce Pro License

Location: wp-admin/admin.php?page=cwg-license-dispatchio-shipment-tracking-for-woocommerce-pro

On this screen:

  • Dispatchio Advanced Shipment Tracking for WooCommerce Pro License
Screenshot: Dispatchio Advanced Shipment Tracking for WooCommerce Pro License
Dispatchio Advanced Shipment Tracking for WooCommerce Pro License

#Settings

Location: wp-admin/admin.php?page=dispatchio-settings

On this screen:

  • Dispatchio Shipment Tracking
  • Order Statuses
  • Tracking in Emails
  • Display
  • Maintenance
Screenshot: Settings
Settings

#Documentation

Location: wp-admin/admin.php?page=dispatchio-docs

On this screen:

  • Dispatchio Documentation
  • Quick start
  • Adding tracking to an order
  • Settings: General
  • Order statuses
  • Tracking in emails
  • Display
  • Maintenance
Screenshot: Documentation
Documentation

#WooCommerce > Settings > Email > Shipped order

Location: wp-admin/admin.php?page=wc-settings&tab=email&section=dispatchio_email_shipped

On this screen:

  • Emails
  • Shipped order
  • Email preview
  • Your Everyday Goods Co. order #12345 has been shipped!
Screenshot: WooCommerce > Settings > Email > Shipped order
WooCommerce > Settings > Email > Shipped order

#WooCommerce > Settings > Email > Partially shipped order

Location: wp-admin/admin.php?page=wc-settings&tab=email&section=dispatchio_email_partial_shipped

On this screen:

  • Emails
  • Partially shipped order
  • Email preview
  • Part of your Everyday Goods Co. order #12345 is on the way!
Screenshot: WooCommerce > Settings > Email > Partially shipped order
WooCommerce > Settings > Email > Partially shipped order

#Dispatchio Shipment Tracking: General

Location: wp-admin/admin.php?page=dispatchio-settings&tab=general

On this screen:

  • Dispatchio Shipment Tracking
  • Order Statuses
  • Tracking in Emails
  • Display
  • Maintenance
Screenshot: Dispatchio Shipment Tracking: General
Dispatchio Shipment Tracking: General

#Dispatchio Shipment Tracking: CSV Import

Location: wp-admin/admin.php?page=dispatchio-settings&tab=csv

On this screen:

  • Dispatchio Shipment Tracking
  • Import Tracking from CSV
  • Sample CSV
Screenshot: Dispatchio Shipment Tracking: CSV Import
Dispatchio Shipment Tracking: CSV Import

#Dispatchio Shipment Tracking: Live Tracking

Location: wp-admin/admin.php?page=dispatchio-settings&tab=live

On this screen:

  • Dispatchio Shipment Tracking
  • Live Delivery Tracking
  • How it flows
Screenshot: Dispatchio Shipment Tracking: Live Tracking
Dispatchio Shipment Tracking: Live Tracking

#Dispatchio Shipment Tracking: Live Tracking: Provider = TrackShip (push updates, needs a TrackShip account and key)

Location: wp-admin/admin.php?page=dispatchio-settings&tab=live

On this screen:

  • Dispatchio Shipment Tracking
  • Live Delivery Tracking
  • How it flows
Screenshot: Dispatchio Shipment Tracking: Live Tracking: Provider = TrackShip (push updates, needs a TrackShip account and key)
Dispatchio Shipment Tracking: Live Tracking: Provider = TrackShip (push updates, needs a TrackShip account and key)

#Dispatchio Shipment Tracking: Live Tracking: Provider = TrackingMore (needs a TrackingMore account and API key)

Location: wp-admin/admin.php?page=dispatchio-settings&tab=live

On this screen:

  • Dispatchio Shipment Tracking
  • Live Delivery Tracking
  • How it flows
Screenshot: Dispatchio Shipment Tracking: Live Tracking: Provider = TrackingMore (needs a TrackingMore account and API key)
Dispatchio Shipment Tracking: Live Tracking: Provider = TrackingMore (needs a TrackingMore account and API key)

#Dispatchio Shipment Tracking: Automation

Location: wp-admin/admin.php?page=dispatchio-settings&tab=automation

On this screen:

  • Dispatchio Shipment Tracking
  • Fulfillment Dashboard
  • Automatic status changes
  • Alerts
  • Customer Tracking Page
Screenshot: Dispatchio Shipment Tracking: Automation
Dispatchio Shipment Tracking: Automation

#Dispatchio Shipment Tracking: FTP Import

Location: wp-admin/admin.php?page=dispatchio-settings&tab=ftp

On this screen:

  • Dispatchio Shipment Tracking
  • Scheduled FTP, FTPS and SFTP Import
Screenshot: Dispatchio Shipment Tracking: FTP Import
Dispatchio Shipment Tracking: FTP Import

#Dispatchio Shipment Tracking: Integrations

Location: wp-admin/admin.php?page=dispatchio-settings&tab=integrations

On this screen:

  • Dispatchio Shipment Tracking
  • Integrations
  • Custom Note Rules
Screenshot: Dispatchio Shipment Tracking: Integrations
Dispatchio Shipment Tracking: Integrations

#Dispatchio Shipment Tracking: PayPal

Location: wp-admin/admin.php?page=dispatchio-settings&tab=paypal

On this screen:

  • Dispatchio Shipment Tracking
  • PayPal Tracking Sync
Screenshot: Dispatchio Shipment Tracking: PayPal
Dispatchio Shipment Tracking: PayPal

#Dispatchio Shipment Tracking: Stripe

Location: wp-admin/admin.php?page=dispatchio-settings&tab=stripe

On this screen:

  • Dispatchio Shipment Tracking
  • Stripe Tracking Sync
Screenshot: Dispatchio Shipment Tracking: Stripe
Dispatchio Shipment Tracking: Stripe

#Dispatchio Shipment Tracking: Tools

Location: wp-admin/admin.php?page=dispatchio-settings&tab=tools

On this screen:

  • Dispatchio Shipment Tracking
  • Outbound Webhooks
  • Export Shipments
  • Moving from another tracking plugin
  • REST API
  • Developer hooks
Screenshot: Dispatchio Shipment Tracking: Tools
Dispatchio Shipment Tracking: Tools

Settings reference

Fulfillment Dashboard

SettingTypeDefaultWhat it does
Search order #, name, email... search -

Dispatchio Shipment Tracking

SettingTypeDefaultWhat it does
Search carriers... search -

Dispatchio Advanced Shipment Tracking for WooCommerce Pro License

SettingTypeDefaultWhat it does
License key text -

Settings

SettingTypeDefaultWhat it does
Enable the custom "Shipped" order status. checkbox on
Enable the custom "Partially Shipped" order status. checkbox on
Enable the custom "Updated Tracking" order status. checkbox on
Enable the custom "Delivered" order status. checkbox on
Show the "Completed" order status to staff and customers as "Shipped". checkbox off
Send the "Updated tracking" email when tracking changes without a status change. checkbox off
Show tracking on the customer order pages under My Account. checkbox on
Add a "Tracking" column to the WooCommerce orders list. checkbox on
Suggest a carrier from the shape of the tracking number as it is typed or scanned. checkbox on
Show an estimated delivery date, based on the days set for each carrier on the Shipping Carriers tab. checkbox on
Log imports and tracking activity to WooCommerce > Status > Logs. checkbox on
When the plugin is deleted (not merely deactivated), also remove its settings and tables. Order tracking data is always kept. checkbox off

WooCommerce > Settings > Email > Shipped order

SettingTypeDefaultWhat it does
Enable/Disable checkbox on
Subject text -
Email heading text -
Email content textarea Hi {customer_first_name}, great news - your order #{order_number} has been shipped. You can track your shipment with the details below.
Additional content textarea -
Email type select HTML Options: Plain text, HTML, Multipart.

WooCommerce > Settings > Email > Partially shipped order

SettingTypeDefaultWhat it does
Enable/Disable checkbox on
Subject text -
Email heading text -
Email content textarea Hi {customer_first_name}, part of your order #{order_number} has been shipped. Track the shipped items below - the rest will follow soon.
Additional content textarea -
Email type select HTML Options: Plain text, HTML, Multipart.

Dispatchio Shipment Tracking: General

SettingTypeDefaultWhat it does
Enable the custom "Shipped" order status. checkbox on
Enable the custom "Partially Shipped" order status. checkbox on
Enable the custom "Updated Tracking" order status. checkbox on
Enable the custom "Delivered" order status. checkbox on
Show the "Completed" order status to staff and customers as "Shipped". checkbox off
Send the "Updated tracking" email when tracking changes without a status change. checkbox off
Show tracking on the customer order pages under My Account. checkbox on
Add a "Tracking" column to the WooCommerce orders list. checkbox on
Suggest a carrier from the shape of the tracking number as it is typed or scanned. checkbox on
Show an estimated delivery date, based on the days set for each carrier on the Shipping Carriers tab. checkbox on
Log imports and tracking activity to WooCommerce > Status > Logs. checkbox on
When the plugin is deleted (not merely deactivated), also remove its settings and tables. Order tracking data is always kept. checkbox off

Dispatchio Shipment Tracking: Live Tracking

SettingTypeDefaultWhat it does
Enable live delivery tracking checkbox off
Provider select 17TRACK (needs a 17TRACK account and API key) TrackShip: user key from my.trackship.com. 17TRACK: key under Settings > API at 17track.net, where it is labelled Security. AfterShip: key from aftership.com. TrackingMore: key under Developer > API Keys at trackingmore.com.
API key password - Stored encrypted. Leave the masked value untouched to keep the current key.
Move the order to Delivered when the carrier confirms every shipment has arrived, which also sends the Delivered email. checkbox on
Stop polling after (days) number 60 Shipments older than this stop being polled. TrackShip does not need it, because it pushes updates itself.

Dispatchio Shipment Tracking: Live Tracking: Provider = TrackShip (push updates, needs a TrackShip account and key)

SettingTypeDefaultWhat it does
Enable live delivery tracking checkbox off
Provider select TrackShip (push updates, needs a TrackShip account and key) TrackShip: user key from my.trackship.com. 17TRACK: key under Settings > API at 17track.net, where it is labelled Security. AfterShip: key from aftership.com. TrackingMore: key under Developer > API Keys at trackingmore.com.
API key password - Stored encrypted. Leave the masked value untouched to keep the current key.
Move the order to Delivered when the carrier confirms every shipment has arrived, which also sends the Delivered email. checkbox on

Dispatchio Shipment Tracking: Live Tracking: Provider = TrackingMore (needs a TrackingMore account and API key)

SettingTypeDefaultWhat it does
Enable live delivery tracking checkbox off
Provider select TrackingMore (needs a TrackingMore account and API key) TrackShip: user key from my.trackship.com. 17TRACK: key under Settings > API at 17track.net, where it is labelled Security. AfterShip: key from aftership.com. TrackingMore: key under Developer > API Keys at trackingmore.com.
API key password - Stored encrypted. Leave the masked value untouched to keep the current key.
Move the order to Delivered when the carrier confirms every shipment has arrived, which also sends the Delivered email. checkbox on
Stop polling after (days) number 60 Shipments older than this stop being polled. TrackShip does not need it, because it pushes updates itself.
Webhook secret password - Optional. From Developer > Webhooks in your TrackingMore dashboard, where it is offered on their V4 webhook tier. Supply it and Dispatchio verifies the signature on every callback, on top of the secret already in the URL below. Leave it empty and the URL secret alone is used. Stored encrypted, so on

Dispatchio Shipment Tracking: Automation

SettingTypeDefaultWhat it does
Processing checkbox on Which order statuses count as still needing to be shipped, and so appear on the Fulfillment dashboard.
On hold checkbox off Which order statuses count as still needing to be shipped, and so appear on the Fulfillment dashboard.
Partially Shipped checkbox on Which order statuses count as still needing to be shipped, and so appear on the Fulfillment dashboard.
Mark shipped orders as Delivered after the number of days below. Use this for carriers you do not track live. checkbox off
Auto-delivered after (days) number 10
Email the shop admin when orders stay unfulfilled longer than the days below. checkbox off
Alert after (days) number 3
Email the shop admin a daily summary of shipments sent, deliveries confirmed and shipments needing attention. checkbox off
Tracking page select Track your order The page holding the [dispatchio_tracking_page] shortcode. Selecting it also turns on shareable tracking links and QR codes in shipment emails and on the order screen.

Dispatchio Shipment Tracking: FTP Import

SettingTypeDefaultWhat it does
Enable scheduled import checkbox off
Protocol select FTPS (FTP over explicit TLS, recommended) Options: FTPS (FTP over explicit TLS, recommended), SFTP (SSH), FTP (unencrypted, not recommended).
Host text - Hostname or IP only, with no protocol prefix and no path.
Port number 21
Username text -
Password password - Stored encrypted. Leave the masked value untouched to keep the current password.
SFTP host key fingerprint text - Optional, SFTP only. Pin the server SHA1 hex fingerprint so a server presenting a different host key is refused, which blocks a man-in-the-middle.
Remote path text /
File prefix filter text -
Delete remote files after a successful import checkbox off
Schedule select Hourly Options: Every 15 minutes, Every 30 minutes, Hourly, Twice daily, Daily.

Dispatchio Shipment Tracking: Integrations

SettingTypeDefaultWhat it does
ShipStation checkbox off
PluginHive FedEx / UPS checkbox off
Germanized / Shiptastic checkbox off
DHL for WooCommerce checkbox off
WooCommerce Shipping checkbox off
Printful checkbox off
Printify checkbox off
Sendcloud checkbox off
Easyship checkbox off
Shippo checkbox off
Shiptheory checkbox off
Pirate Ship checkbox off
AliExpress / Ali2Woo checkbox off
Qapla' checkbox off
Generic tracking notes checkbox off

Dispatchio Shipment Tracking: PayPal

SettingTypeDefaultWhat it does
Sync tracking to PayPal checkbox off
Use the PayPal sandbox environment checkbox off
Client ID text -
Client Secret password - Stored encrypted. Leave the masked value untouched to keep the current secret.

Dispatchio Shipment Tracking: Stripe

SettingTypeDefaultWhat it does
Sync tracking to Stripe checkbox off
Secret key (optional) password - Stored encrypted. Leave the masked value untouched to keep the current key.

Dispatchio Shipment Tracking: Tools

SettingTypeDefaultWhat it does
Send webhook notifications checkbox off
Endpoint URL url -
Signing secret password - Stored encrypted. Leave the masked value untouched to keep the current secret.
Tracking added to an order checkbox on
Tracking removed from an order checkbox off
Carrier confirmed delivery checkbox on
Delivery exception / failed attempt checkbox on
From date -
To date -

Shortcodes

[dispatchio_tracking_page]

Shortcode registered by the plugin.

[dispatchio_tracking_page]

On your site

These pages show what visitors see on your site.

Screenshot: Track your order
Track your order