Dispatchio - Advanced Shipment Tracking for WooCommerce documentation

Dispatchio lets you add one or more tracking numbers to each WooCommerce order and keeps your customers informed. It adds real order statuses (Shipped, Partially Shipped, Updated Tracking and Delivered), each with its own email, and shows tracking details in WooCommerce emails, in My Account and on a public tracking page.

The Pro edition is a standalone plugin. It contains everything in the free edition and adds live delivery tracking through TrackShip, 17TRACK or AfterShip, a fulfillment dashboard with a scanner mode, scheduled FTP, FTPS and SFTP imports, integrations with shipping apps, PayPal and Stripe tracking sync, shipment analytics, outbound webhooks and WP-CLI commands.

It is built for WooCommerce store owners and fulfillment staff who ship physical orders and want a single place to record, import and follow shipments.

Dispatchio Pro needs WooCommerce, so install and activate WooCommerce first. You do not need the free edition of Dispatchio. If it is installed, activating Pro deactivates it for you, and your settings, carriers and tracking data carry over untouched.

Dispatchio > Fulfillment lists every order that still needs to be shipped, so you can add tracking and fulfill orders without opening each one.

Each row shows the Order, Date, Status, Customer, Products Ordered, a Carrier dropdown and a Tracking Number field. To ship an order:

1. Choose the carrier in the Carrier dropdown.
2. Type or scan the number into Tracking Number.
3. Click Fulfill.

Click Split to send an order in several parcels, each with its own tracking number.

The toolbar gives you:

• A search box to find an order by number, name or email.
• Refresh to reload the list.
• Print picking list for a print-friendly list of the items to pack.
• Scanner mode, which lets you scan the order barcode, then the shipping label, and moves straight to the next order without touching the mouse.

Which order statuses count as unfulfilled is set under Settings > Automation > Unfulfilled statuses.

On the order edit screen, the Dispatchio box lets you add tracking by hand. Choose a carrier, type or scan the tracking number and click Add Tracking. You can add several tracking numbers to one order.

When some items have tracking and some do not, the order uses Partially Shipped, and it moves to Shipped once the last item is covered. You can also search the WooCommerce orders list by tracking number: pick Tracking number in the orders search dropdown.

Dispatchio > Settings > General controls the order statuses, which WooCommerce emails show tracking, and where tracking is displayed.

• Order Statuses: each status is a real WooCommerce order status with its own email. Turn off any you do not need. Rename Completed shows the standard Completed status as "Shipped" without changing the underlying status. Tracking update email sends the Updated Tracking email when tracking changes on an order that is already shipped.
• Tracking in Emails: Dispatchio adds a tracking block to the ticked emails (Processing order, Completed order, Customer invoice, Customer note, Refunded order). Untick an email to leave it unchanged.
• Display: show tracking in My Account, add a Tracking column to the orders list, suggest a carrier from the tracking number format and show an estimated delivery date.
• Maintenance: log activity to WooCommerce > Status > Logs, and choose whether deleting the plugin removes its settings and tables. Order tracking data is always kept.

Click Save Settings when you are done.

Dispatchio > Settings > Shipping Carriers lists the built-in carriers with their Country, Tracking URL, Est. days and Type.

• Tick Active for the carriers you ship with. Only active carriers appear in the carrier dropdown on an order. Keeping the list short speeds up fulfillment.
• Use Search carriers... to find a carrier quickly.
• Click Edit to change a carrier. You can rename it, change the tracking link pattern (%number% for the tracking number, plus %postcode% or %phone% for carriers that need them), add API aliases (other spellings used in import files, comma separated), set the PayPal carrier code and set the estimated delivery days (0 shows no estimate).
• Click Add Custom Carrier to add a carrier that is not in the list.

Dispatchio > Settings > CSV Import adds tracking to many orders at once.

1. Prepare a CSV file with a header row and these columns: order_id, tracking_provider, tracking_number, date_shipped, status_shipped, sku, qty.
2. For status_shipped, use 1 for shipped, 2 for partially shipped or 0 for no status change.
3. Click Choose File and select your file.
4. Click Preview to check the rows, then Import.

Rows that share an order and a tracking number are merged into one shipment. This is how you record per-item tracking with the sku and qty columns. The tab shows a sample CSV you can copy.

Dispatchio > Settings > Live Tracking connects a tracking service so Dispatchio follows each parcel with real carrier data.

1. Tick Enable live delivery tracking.
2. Choose a Provider: TrackShip, 17TRACK or AfterShip. You need an account with that provider, and they bill you directly.
3. Paste your API key (TrackShip: user key from my.trackship.com; 17TRACK: key under Settings > API at 17track.net; AfterShip: key from aftership.com).
4. Click Save Live Tracking Settings, then Test API Key.
5. Copy the Webhook URL shown on the tab into your provider dashboard for instant updates. An hourly check runs even without it.

Once enabled, a shipment is registered with the provider as soon as you add tracking. Live status and checkpoints appear on the order, in the orders list, in My Account and on the tracking page. With Auto-mark Delivered on, the order moves to Delivered when the carrier confirms every shipment has arrived, which also sends the Delivered email. Use Sync All Now to refresh all shipments at once.

This feature sends tracking numbers to the service you choose. Review that provider's terms and privacy policy and mention it in your own privacy policy.

Dispatchio > Settings > Automation groups the rules that run on their own.

• Fulfillment Dashboard: choose which order statuses count as still needing to be shipped (Processing, On hold, Partially Shipped). Only those orders appear on the Fulfillment dashboard.
• Automatic status changes: mark shipped orders as Delivered after a set number of days. Use this for carriers you do not track live.
• Alerts: email the shop admin when orders stay unfulfilled too long, and send a daily digest of shipments sent, deliveries confirmed and shipments needing attention.
• Customer Tracking Page: select the page that holds the [dispatchio_tracking_page] shortcode. Selecting it also turns on shareable tracking links and QR codes in shipment emails and on the order screen.

Click Save Automation Settings to apply your changes.

Dispatchio > Settings > FTP Import connects to your server on a schedule, downloads tracking CSV files and imports them with the same rules as a manual CSV import. Credentials are stored encrypted.

1. Tick Enable scheduled import.
2. Choose the Protocol: FTPS (recommended), SFTP or plain FTP (not recommended).
3. Enter the Host (hostname or IP only, with no protocol prefix and no path), Port, Username and Password.
4. For SFTP, you can pin the server's SHA1 SFTP host key fingerprint so a server with a different key is refused.
5. Set the Remote path, an optional File prefix filter, and whether to delete remote files after a successful import.
6. Pick a Schedule, from every 15 minutes to daily.
7. Click Save FTP Settings, then Test Connection. Use Run Import Now to import immediately.

Dispatchio > Settings > Integrations captures tracking numbers created by other shipping apps and runs your normal fulfillment workflow, as if you had typed them in. Enable only the apps you actually use.

There are two kinds of integration:

• Direct hook: ShipStation, PluginHive FedEx / UPS, Germanized / Shiptastic, DHL for WooCommerce and WooCommerce Shipping. Tracking is imported when the app creates a label or marks a shipment.
• Order-note parser: Printful, Printify, Sendcloud, Easyship, Shippo, Shiptheory, Pirate Ship, AliExpress / Ali2Woo, Qapla' and Generic tracking notes, which catches common "Shipped via X, tracking number Y" notes from any app.

Custom Note Rules handle apps that are not listed. Click Add Rule, give it a Label and a Regex pattern that matches the order note the app leaves. Capture group 1 must be the tracking number, and group 2, if present, the carrier. Fill in Carrier (fixed) instead when the app always uses one carrier. Click Save Rules.

These tabs send tracking details to the payment provider when an order ships, which gives you proof of shipment in a dispute.

PayPal (Dispatchio > Settings > PayPal) sends tracking numbers for orders paid with PayPal, which also speeds up fund releases.

1. Create a REST API app in the PayPal Developer Dashboard to get credentials.
2. Tick Sync tracking to PayPal, and tick Use the PayPal sandbox environment if you are testing with sandbox credentials.
3. Enter the Client ID and Client Secret, click Save PayPal Settings, then Test Credentials.

A failed sync is queued and retried hourly, up to five attempts. Map each carrier to its PayPal carrier code on the Shipping Carriers tab.

Stripe (Dispatchio > Settings > Stripe) attaches the carrier and tracking number to the Stripe PaymentIntent metadata for orders paid through Stripe. Tick Sync tracking to Stripe and click Save Stripe Settings. The Secret key (optional) field can stay empty: the key from the official WooCommerce Stripe gateway is used.

Dispatchio > Settings > Tools holds webhooks, exports and developer information.

Outbound Webhooks send a signed JSON POST to your endpoint when shipment events happen. Tick Send webhook notifications, enter the Endpoint URL and a Signing secret, choose the Events, and click Save Webhooks. Verify the X-Dispatchio-Signature header (HMAC-SHA256 of the raw body with your secret) before trusting a payload.

Export Shipments downloads the shipment log as CSV (order, carrier, tracking number, ship date, live status and delivery date). Pick the From and To dates and click Download CSV.

Moving from another tracking plugin: Dispatchio reads and writes the same order meta key used by other popular tracking plugins, so existing tracking numbers show up straight away. Deactivate the old plugin; there is no import step.

REST API endpoints, authenticated with WooCommerce REST API keys:

• GET/POST /wp-json/wc/v3/orders/{order_id}/shipment-trackings
• GET/DELETE /wp-json/wc/v3/orders/{order_id}/shipment-trackings/{tracking_id}
• GET /wp-json/wc/v3/orders/shipment-trackings/providers
• POST /wp-json/wc/v3/orders/shipment-trackings/bulk

Developer hooks include dispatchio_tracking_item_added, dispatchio_tracking_item_deleted, the helper dispatchio_add_tracking_number( $order_id, $number, $carrier ) and the dispatchio_manage_capability filter.

Dispatchio > Documentation explains every option in the order you meet it in the interface. It covers the quick start, adding tracking to an order, each settings tab, shipment emails, the REST API, developer hooks, privacy and data, troubleshooting, and the Pro features such as live tracking, the fulfillment dashboard, automation, FTP import, integrations, payment sync, the customer tracking page, webhooks, SMS and WhatsApp hooks and WP-CLI.

Use the On this page list at the top to jump to a topic.

Dispatchio > Analytics summarizes your shipping activity. Choose a period with Last 7 days, Last 30 days, Last 90 days or Last 365 days.

The page shows:

• Totals for Shipments, Avg. time to ship and Delivered.
• Shipments per carrier, as a bar chart.
• Shipments per day, as a chart over the chosen period.
• Tracking source, a table showing how tracking was added (for example manually or by import).

For a date-ranged CSV of shipments, use Export Shipments on the Tools tab.

Dispatchio adds its own emails under WooCommerce > Settings > Emails, including Shipped order (sent when the order status changes to Shipped, with tracking details) and Partially shipped order (sent when the status changes to Partially Shipped). The Delivered and Updated Tracking statuses also have their own emails.

Each email has the usual WooCommerce fields: Enable/Disable, Subject, Email heading, Email content, Additional content and Email type. Besides the standard placeholders such as {site_title}, {order_number} and {customer_first_name}, every Dispatchio shipment email accepts {tracking_number}, {carrier_name} and {tracking_url} in the subject, heading, content and additional content.

Use the Email preview to check the result, and click Send a test email to see it in your inbox. Click Save changes when you are done.

Customers see tracking in several places:

• Tracking page: the page with [dispatchio_tracking_page] shows a Track Your Order form. The customer enters the Order Number and Billing Email and clicks Track to see where the parcel is, with a shipment timeline. With live tracking enabled, the status and carrier checkpoints appear here too.
• Emails: the Shipped, Partially Shipped, Updated Tracking and Delivered emails include tracking details, and so do the WooCommerce emails you tick on the General tab. When a tracking page is selected, shipment emails also include a shareable tracking link and a QR code.
• My Account: tracking appears on the customer order pages when My Account is enabled on the General tab, with live status when live tracking is on.