WooCommerce Orders Tracking


Created: 03/2020

Latest updated: 10/2022 – Updated version: 1.1.3

By: VillaTheme

Thank you for purchasing our plugin. If you have any questions that are beyond the scope of this documentation, please feel free to request support at our Support Forum. Thanks so much!

 

Description

WooCommerce Orders Tracking lets your customers view the live tracking info for all of their purchases. With the plugin, you keep your customers updated about their order tracking information via different channels; you can add, edit, import tracking numbers; export orders; provide your customers with tracking URLs that help them track their order directly; … All these functions help you save time, create a nicer experience for your clients, and reduce the workload.

WooCommerce Orders Tracking works with 90+ shipping companies and several payment gateways, but with PayPal, it’s possible to attach tracking info to customers’ transaction details in their PayPal accounts. Informing the tracking info changes by SMS is what makes our plugin different. Moreover, you can send emails/SMS in different languages if you’re using Polylang/WPML

With WooCommerce Order Tracking, you can: 

  • Manage tracking by order; order items; or both: Control the tracking number at the item level in each order. Add tracking on the order list page.
  • Select existing shipping carriers: WooCommerce Orders Tracking integrates with 92 shipping companies and includes all the popular carriers and many small regional shipping providers from different countries worldwide.

  • Create a custom shipping carrier: If you want to add more shipping carriers that have not been available on the shipping carrier list, you can create new ones.
  • Send WooCommerce orders tracking emails: When the tracking info changes, send emails to inform your customers. Work well with WooCommerce Email Template Customizer to create various order tracking email templates.

  • Include tracking info to WooCommerce email: Attach tracking info, select order status emails to attach, and manage the tracking content with necessary information.

  • Inform customers by SMS: When the tracking info changes, notify your customers by SMS. The plugin is currently integrated with 3 SMS providers: Twilio, Nexmo, and Plivo.

  • Add the tracking info into the customer’s order summary in their PayPal account: The PayPal option helps you to automatically add tracking numbers to PayPal transactions. Compatible with many core PayPal plugins in the market.

  • Webhook: Allows you to get notifications right after the tracking is updated and it triggers an update of one of your trigger settings.

  • Schedule to update the latest data for all tracking numbers: If you use a tracking service to track shipping information by API key, this function helps you update the latest data of the respective tracking service.

  • Add the tracking number manually: In the order details of each order, you can add the tracking number, bulk set the tracking number, and send email and SMS with the tracking URL generated,… manually.

  • Export orders/Import tracking numbers with CSV files: This function helps you save time to add tracking information in bulk.

  • Tracking service: Connect with 3rd tracking service to track shipping information via API: TrackingMore, EasyPost, Cainiao, Aftership, Tracktry and 17Track
  • Create a WooCommerce Orders Tracking page after activating the plugin: The page is created right after the plugin is activated, but you can also select a page and make it the Order Tracking page.

  • Customize tracking page: Many options and features for you to design the tracking page as you desire.

  • Translate timeline on the tracking page: This allows you to use Google Cloud Translation API to translate the order tracking timeline on the Tracking page.

  • Default tracking information and tracking number: This feature reduces after-purchase support for new orders when the tracking number is not available but without any info.

  • Google Recaptcha: This setting helps you protect your website from spam and abuse.
  • Use shortcodes to display tracking forms: WooCommerce Orders Tracking provides shortcodes to display tracking forms

  • Use the plugin along with WPML, Polylang: You can send Email/SMS/attach tracking info to WooCommerce emails in the customer’s native language.

  • Rest API to get/set tracking for an order
  • Manage to allow which one can be able to change settings and use the plugin: Administrators or Shop managers.
  • Support developers

System Requires:

Make sure that those limits to a minimum as follows in order for free-trouble while installing:

  • WordPress4.6.x or higher
  • Woocommerce 3.0.x 
  • max_execution_time 60
  • memory_limit 125M
  • post_max_size 64M
  • upload_max_filesize 64M

Download Plugin:

Go to Plugin/Add New/Upload Plugin/Choose file/ select plugin zip file woocommerce-order-tracking /click “Install Now“/click “Active plugin“.

Done! Let’s start using the plugin.

Guiding video on how to install and set up:

Go to the settings to configure the plugin.

 

SELECT/ADD SHIPPING CARRIER

Firstly, you will select a shipping carrier as default if you normally stick with one carrier. See this instruction for how to select a Shipping carrier and add a custom Shipping carrier.

 

EMAIL 

After selecting a shipping carrier, go to the Email tab and manage the settings of the Order Tracking email sent to customers when tracking info is changed. Please regard this part for more details of each option.

 

WOOCOMMERCE EMAIL

In this tab, you can include the tracking information in WooCommerce emails, select the order status emails, position of the tracking info; and manage the tracking content. Visit this documentation to know it better.

 

SMS

Configure this tab to enable the SMS tracking information message feature. Follow this guide to configure it successfully.

 

PAYPAL

Then go to the PayPal tab if you want to automatically add tracking numbers to customers’ order summary in their PayPal account. See the instruction and the tutorial video for how to make this function work.

 

TRACKING SERVICE

Go to the Tracking Service tab to track orders with a 3rd party shipping. You can refer to this part for more information and how to get  the API key

 

Now you are able to add tracking numbers to the orders and your customers can track them on the carrier website.

General

In the General tab, you can manage the tracking number at the item level in each order (by Items only) or by Order only. This feature is beneficial if you do AliExpress dropshipping, please DO NOT choose “Order only” as each item of an AliExpress order can have its own tracking number. If our dropshipping plugin(ALD) is active, it will override this feature to make the tracking number field available for every item of an order.

 

1. Manage tracking by:

  • Order only – Each order can have 1 tracking number at a time
  • Order items only – Each order item has its own tracking number
  • Both order and order item

2. Track per item quantity:  If enabled, a tracking number field will appear for each purchased quantity of an order item. “Order only” must NOT be selected under “Manage tracking by.”

 

* Note: You can manage (add/edit) order tracking information on the Admin Orders List page.

Add tracking info for the whole order:

Add tracking info to each item in the order:

💡Helpful:

You can quickly switch among orders to add, edit order tracking info in the order list page, which saves time because you don’t need to get out the popup and click to other editing tracking icons on the order list page or go to each order editing page to manage the order tracking.

A. Order only – Each order can only have 1 tracking number at a time

 

B. Each order item has its own tracking number:

  • Each order item has its own tracking number (Disable )

  • Each order item and the quantity of each item (Enable )

 

Shipping Carriers

Shipping Carriers are individuals or businesses that transport goods or people on behalf of another individual or business and are liable for any loss of the goods during transport. Each shipping carrier formed in the plugin has 4 information: Carrier Name, Display Name, Shipping Country, and Tracking ULR of the carrier.

In the Shipping Carriers tab, you can select available shipping carriers or customize the shipping carriers that you use on your site. The plugin will generate tracking links to the tracking page of the carriers.

A. Available Shipping Carriers

There are over 90 shipping companies integrated into our plugin that you can quickly choose and assign for your orders.

Go to Orders Tracking > Shipping Carriers

  1. Filter carrier: You can use the plugin’s pre-integrated shipping carriers or add new carriers. This filter helps you to find pre-integrated shipping carriers or custom shipping carriers you added more quickly.
  2. Filter countries: This filter helps you to search shipping carriers by country.
  3. Activate all: This toggle allows you to display or hide only shipping carriers that you work with.
    • For example, it will save you time to only show the two shipping companies you are currently using, allowing you to select one quickly when assigning a shipping carrier for an order.
  4. Default Shipping carrier: If any orders that do not assign with a shipping carrier, this default one will be used.
  5. In a shipping carrier (not default)
    • Copy carrier slug
    • Select as default shipping carrier
    • Edit shipping carrer

Note: Pre-integrated shipping carrier information is defined with carrier name, shipping country and carrier url. You can just change the display name which you want to mask with another custom name when showing them to the customer.

B. Custom Shipping Carriers

If you want to add more shipping carriers which have not been available in the shipping carrier list, you can do this by clicking Add carriers

a. You can add your own carrier:

 

  1. Add your custom carrier: Enter your custom carrier.
  2. Carriers Name: Enter your custom shipping carrier name
  3. Display Name: Enter the display name which you want to mask with another custom name when showing them to the customer.
  4. Carrier slug: Add your custom carrier slug which is simple for you to manage.
  5. Shipping Country: Select the country where the shipping carrier ships.
  6. Tracking URL: Enter the shipping carrier’s URL

Please watch this video to find out how to add a custom shipping carrier.

Note: When you add a custom carrier, if you’re using a tracking service that needs a valid API in the Tracking Service tab (EasyPost, AfterShip, Tracking More), the Carrier Name of the custom shipping carrier must be the same as its name in the supported shipping carrier list of that tracking service.

You can find the name of the supported shipping carrier with the links below:

b. You can choose the carrier supported by a tracking service

  1. Choose from one of shipping carriers which are supported by available tracking service: TrackingMore; 17Track; Tracktry;
  2. Select a carrier: Select your shipping carrier from the list.

Email

When a tracking number is added to an order and whenever the tracking information of the order changes, the plugin will send the confirmation email to the customers

In the Email tab, you can set up the email contents.

1. Setting up the tracking emails: Send an email to customers whenever a tracking number is added to the orders.

 

  • Send tracking of whole order: Send tracking of all items of an order instead of only changed one. Helpful when you add tracking numbers for single items of an order.
  • Email subject: Enter your tracking email subject.
  • Email heading: Enter your tracking email heading.
  • Email content: Type in the email content. You can use shortcodes to display the necessary information.
  • Tracking number column, Carrier number column, Carrier name column, Tracking URL column: These customizers allow you to modify the tracking table with each respective section.

2. The setting for sending emails when importing tracking numbers

  • The number of emails sent per time: To avoid being marked as Spam, you can select the quantity of tracking emails that will be sent at one time.
  • Delay between each time: The delay time that each email is sent.

 

WooCommerce Email

WooCommerce Email settings allow you to include tracking information in the WooCommerce emails, select the order status emails you want to include tracking info.

 

 

1. Include tracking in WooCommerce email: Enable this option to include tracking information in the WooCommerce emails

2. Order status email: Select orders status to include the tracking information.

3. Tracking info position: Choose a position to place the tracking information. With a particular position for the tracking information you choose, you need to add the WC Hook to the email template assigned, and select the corresponding position for the hook.

For example; if you select ‘Before order table’ for the ‘Tracking info position’ option, then in the email you want to attach the tracking info, there must be WC Hook with the position ‘Before order table’

4. Tracking content, Tracking list item, Tracking Number, Tracking Carrier: The tracking information includes these elements. Manage how the tracking information is shown in WooComemrce emails with each element.

 

SMS

The SMS function allows you to inform your customers by SMS when the orders tracking information changes.

This function works with 3 providers: Twilio, Nexmo and Plivo.

 

 

  1. Message text when new tracking is added: Manage the content of the message when the tracking number is added to the order.
  2. Message text when tracking changes: Message content when the tracking number of order is changed.
  3. SMS provider: Choose an SMS provider.

With each provider, configure its required sections with corresponding information.

* SMS Provider: There are 3 SMS Provider options for you to choose including Twilio, Nexmo and Plivo. Here are the guidelines:

  • Guide to set SMS with Twilio SMS Provider:
  • Please check your regional permission to send SMS for Twillo in your Twillo Settings

 

  • Guide to set SMS with Nexmo SMS Provider:

 

  • Guide to set SMS with Plivo SMS Provider:

4. Send test SMS

After configuring a SMS provider, you can send SMS test to check the connection.

5. Send SMS when syncing Aliexpress orders: This option will appear only when you activate the ALD – Aliexpress Dropshipping and Fulfillment for WooCommerce plugin. SMS will be sent to the customers once their Aliexpress orders are updated tracking number when this option is enabled.

To send SMS, go to WooCommerce/Orders/ edit order/ edit tracking order, change the tracking information, enable the send SMS to customer if tracking info changes option.

 

PayPal

The PayPal option helps you to automatically add tracking numbers to the PayPal transactions. This option requires the Client ID and Client Secret.

  1. Payment method: Each PayPal plugin you activate will have a corresponding payment method in this column.
  2. Is sandbox: Enabling/Disabling this option depends on whether you’re using the sandbox mode or not
  3. Client ID: Add the client ID.
  4. Client Secret: Add the Client Secret
  5. Action: Test the connection to make sure the function works. If all the required fields are correct, the green notice “Successfully” will appears.
  6. Debug: If enabled, each time there is an error, a raw request to the PayPal API will be logged.

Note: In case you’re using different PayPal plugins, which creates different PayPal payment methods, you just need to fill in the Client ID and Client Secret of Default Live API and/or Default Sandbox API, and the other payment methods will use these APIs to work, depends on which mode you’re using. In case you don’t want to use the mutual APIs, please fill each payment method with their own Client ID and Client Secret to make it work

How to add orders tracking information on PayPal transaction, testing with a sandbox account:

 

Tracking Service

 

 

A. General settings

You can use the Tracking Service instead of using shipping carriers. This option allows you through a 3rd party to track shipping information by API key.

  1. Enable: Enable the option to track shipment information with a 3rd party.
  2. Service: Select the tracking service you want to use. At the moment the plugin supports TrackingMore, EasyPost, Cainiao, Aftership, Tracktry and 17Track. You can see detailed information about how to connect each tracking service below.
  3. Tracking page: Select a page by title and make it the order tracking page. Customers can track the shipping information from a tracking page on your website.
    • The page is Order Tracking by default (is automatically created by our plugin when activated), the admin can create their own pages and add the shortcode to display the tracking form to make it their own order tracking page. See this documentation of Shortcodes provided by our plugin.
  4. Cache request: When customers search for a tracking number on the tracking page, the result will be saved to use for the same research for this tracking number within this cache time.
  5. Customize Tracking page: A link leads you to the Design of the Tracking page. You can see the instruction in the Design tracking page section below.

 

B. Connect tracking service via API

  • Cainiao: You can connect Cainiao directly without API.

Other than Cainiao, you need to fill the API key generated in your corresponding tracking service account, select some more options to complete the configuration, so you can connect to the other 4 tracking services successfully.

  • Other tracking services: TrackingMore, EasyPost, AfterShip, Tracktry and 17Track

  1. Service: Select one tracking service – TrackingMore; EasyPost; AfterShip, Tracktry or 17Track.
  2. API key: Enter the API key generated in your corresponding tracking service account
    • TrackingMore: If you don’t have an account, click here to create an account and generate an API key. You can register for the free plan or paid plan.
    • EasyPost: If you don’t have an account, click here to create an account and generate an API key. You can register for the free plan or paid plan.
    • AfterShip: If you don’t have an account, click here to create an account and generate an API key. You can register for the free plan or paid plan.
    • 17Track: Create and log in to your account here, then go to the management console -> Settings ->Security-> Access Key, you can get the access key.
    • Tracktry: Click here to register an account here, then go to Settings to copy API key You can register for the free plan or paid plan.
  3. Add tracking if not exist: When customers search for a tracking number that exists in your current orders, add it to your tracking API if it does not exist in your API tracking list.
  4. Change Order Status: Select order status to change to when Shipment status changes to Delivered. Leave it blank if you don’t want to change order status.

 

C. Customize tracking page

When you click on customize your tracking page, you can design the tracking page as you want.

  • In the General tab:

1. Sort events: You can order the events into 2 types: Most recent to oldest and oldest to most recent.

2. Date format: Select the date format.

3. Time format: Select the time format.

4. Translate datetime: Datetime displays by default in English. It will be translated to your site’s locale if you check this option.

5. Timeline template: There are 2 templates.

6. Title: Add the title.

7. Title text alignment: This can be left, right, center.

You can also customize text, background color, the font size in the general tab.

  • In the Tracking form tab: You will determine which information fields customers must provide in order to call shipment tracking timeline on the tracking page and customize the tracking button on the tracking page: Background and text colors.

  • In the Design template tab: You can select your desired icons and their colors: Delivered icon, Pickup icon, In-transit status icon.

  • In the Custom CSS tab: You can add a custom CSS here.

 

 

D. Translate timeline

From version 1.0.7 of the WooCommerce Orders Tracking plugin, we integrated a new feature: “Translate timeline”, which allows translating the orders tracking timeline on the Tracking page using Google Cloud Translation API.

See this video for how to get an API key to add in the plugin and use the Translate timeline feature of the WooCommerce Orders Tracking plugin.

 

Enable/Select/Add the correct information to each field to configure this function. See the instruction below for how to connect to each tracking service.

 

 

E. Default tracking info and tracking number

  • This feature is to reduce after-purchase support for new orders when the tracking number is not available, or available but without any info
  • Row with empty description will not show on the tracking page
  • Time is relative to an order’s created time
  • Tracking service must be enabled and a tracking page must be set

 

e1. Default tracking info

1. Show default tracking info: Show below track info in the tracking timeline if a real tracking number does not have any information from the tracking service.

2. Default carrier name: The carrier which will show for the default track info

3. Show if order status: Display milestones (since order created); shipment status and shipment tracking description with respectively selected WooCommerce order statuses.

4. Time (since order created): Create milestones since order created to delivered.

5. Status: Describe shipment status with a respective milestone: Pending; In transit or Pickup.

6. Description: Describe the shipment status.

7. Delete tracking info.

8. Duplicate tracking info.

 

e2. Default tracking number

1. Default tracking number: If an order does not have a tracking number, the default tracking number will be displayed on the Order received page, My account/orders, and in emails that you configủe on the WooCommerce Email tab. When a customer uses a “default tracking number” to track, the default track info will be used.

2. Content: Message including default tracking number which will be displayed on Order received page or WooCommerce email.

3. Position: Position of the default tracking number message on the Order received page.

 

 

F. Google reCAPTCHA

Go to Orders Tracking/ Tracking Service/ Google reCAPTCHA for the tracking form.

This setting helps you protect your website from spam and abuse.

  • ReCaptcha 2: “I’m not a robot” Checkbox. This requires the user to click a checkbox indicating the user is not a robot. This will either pass the user immediately (with No CAPTCHA) or challenge them to validate whether or not they are human. This is the simplest option to integrate with and only requires two lines of HTML to render the checkbox.
  • ReCaptcha 3: reCAPTCHA v3 allows you to verify if an interaction is legitimate without any user interaction. It is a pure JavaScript API returning a score, giving you the ability to take action in the context of your site: for instance requiring additional factors of authentication, sending a post to moderation, or throttling bots that may be scraping content.

 

 

Advanced Settings

In the Advanced Settings, you can manage to allow which one can be able to change settings and use the plugin.

You will select an user role (Administrators or Shop managers) who can manage the plugin:

1. Change the plugin’s main settings.

2. Change webhooks settings.

3. Change schedule settings.

4. Export tracking.

5. Import tracking.

6. Customize tracking page.

7. Access Logs page.

 

 

WEBHOOKS

Webhook API allows you to get notifications for when the tracking is updated and it triggers an update of one of your trigger settings.

 

A. How to configure the webhook of 17Track

A webhook is not part of the 17TRACK API. It’s an interface created by you in the form of a URL to receive the tracking status pushed by the 17TRACK Tracking API.

1. Enable webhook: Turn this option on to use this feature of 17Track

2. Enable debug: Data from webhooks will be logged for debugging purposes if enabled.

3. Send Email: Select the statuses that you want to be notified of.

4. Webhook URL: Copy Webhook URL and paste it to Webhook URL field – Webhook settings in your 17Track account.

* Follow the guide below and save all configurations.

Step 1: Copy the Webhook URL in number (4)

Step 2: Log in to your 17Track account. Go to Settings and paste the URL above as the image below.

Step 3: Choose a version, recommend the lastest V 2.0

Step 4: Under Notification settings, select statuses to receive a notification when tracking information changes.

Step 5 (Optional): Do a quick test and see if it works.

Go to the [WebHook test] section on the left, paste your Webhook URL to the input box and click on the [Test] button. If a notification in green pops up saying “Operation Done”, then it works.

Step 6: Check webhook logs

Go to Orders Tracking > Logs, select Webhooks, date, and view the log.

Step 7 (If needed): Check webhook debug. Check the log debug to see if there is a problem.

Go to Orders Tracking > Logs, select Webhook debug, date, and view the log.

 

 

 

B. How to configure the webhook of TrackingMore

When you select TrackingMore as your tracking service, the webhook section will trigger the webhook setting of TrackingMore.

1. Enable webhook: Turn on to use this feature of TrackingMore

2. Enable debug: Data from webhooks will be logged for debugging purposes if enabled.

3. TrackingMore Email: Enter the address you registered in TrackingMore.

4. Send Email: Select the statuses that you want to be notified of.

*Note: Statuses you select here must be selected in your Webhook settings

5. Webhook URL: Copy Webhook URL and paste it to Webhook URL field of your Webhook Notification Settings.

* Follow the guide below and save all configurations.

Step 1: Go to https://my.trackingmore.com/webhook setting.php

Step 2: Copy Webhook URL in the plugin (4) and paste it to the Webhook URL field of your Webhook Notification Settings

 

C. How to configure the webhook of EasyPost

When you select EasyPost as your tracking service, the webhook section will trigger the webhook setting of EasyPost.

1. Enable webhook: Turn on to use this feature of EasyPost

2. Enable debug: Data from webhooks will be logged for debugging purposes if enabled.

3. Webhook secret: This helps prevent any third parties from masquerading as EasyPost and sending fraudulent data

4. Send email: Select the statuses that you want to be notified of.

5. Webhook URL: Add webhook URL using this Webhook URL

* Follow the guide below:

Step 1: Go to Webhooks & Events

Step 2: Click on the Add Webhook button, copy Webhook URL in the plugin (4) and paste it to the Webhook URL field and create the webhook.

 

 

D. How to configure the webhook of AfterShip

When you select AfterShip as your tracking service, the webhook section will trigger the webhook setting of AfterShip.

1. Enable webhook: Turn on to use this feature of AfterShip

2. Enable debug: Data from webhooks will be logged for debugging purposes if enabled.

3. Webhook secret: This helps prevent any third parties from masquerading as AfterShip and sending fraudulent data

* You can find the Webhook secret in your AfterShip Notification settings

4. Send email: Select the statuses that you want to be notified of.

5. Webhook URL: Copy Webhook URL and paste it to Webhook URL field

* Follow the guide below:

Step 1: Go to Notification settings and scroll down to the bottom of the page

Step 2: Click on the Add Webhook button, copy Webhook URL in the plugin (4) and paste it to the Webhook URL field and save.

 

 

 

SCHEDULE UPDATE

If you use tracking service to track shipping information by API key, you can set to update the latest data of the respective tracking service.

Go to the Schedule update section of the plugin setting:

    1. Enable cron: Enable to activate the update feature.
    2. Run update every: Set the time to update after x day.
    3. Run update at: Set a specific time to update.
    4. Only query tracking created in the last x day(s): Set update within x last day (s).

 

IMPORT & EXPORT

The plugin allows you to export order data into a CSV file, you can select the data you want to export.

Then you can edit the tracking information in the exported file, and import it back.

This function helps you save time when importing/changing tracking numbers in a large amount.

 

A. Export orders

Go to Dashboard/ Order Tracking/ Export Orders, select the orders you need to add tracking number.

  1. Filename: enter the name of the export CSV file.
  2. Filter by orders: this option allows you to specify the order you want to export by date, status, bill address, shipping address, payment methods and shipping methods.
  3. Fields: select the fields you want to exports. If you leave this empty, all the fields will be exported.
  4. Tool buttons: Preview; Save filter settings; Export orders; Reset filter settings.
    • Preview: Display the table data after exporting

    • In the exported file, you add the Tracking ID, Carrier Slugs, Carrier Name, Carrier type of each product.

* Note: Carrier slugs: You can add in 2 ways: Get the carrier slugs list here or go to the shipping carrier tab of the plugin setting to get carrier slugs.

 

B. Import tracking

Then you can go to Dashboard/ Order Tracking/ Import Orders Tracking to import the CSV file you just edited.

Mapping fields and import.

 

 

 

EDIT/ADD TRACKING INFO MANUALLY

To add tracking numbers manually please go to Dashboard/ WooCommerce/ Orders select the order you want to add the tracking number and click on the Edit Tracking button.

 

1. and 3. The Edit tracking button: Click this button to edit tracking information including: Tracking number, Tracking carrier, Shipping carrier, Change order status; then enable/disable sending email and/or adding tracking number to PayPal after saving.

2. Add a tracking number to PayPal.

 

 

SHORTCODES

The plugin provides shortcodes to:

  1. Display the TrackingMore tracking form: [vi_wot_tracking_more_form]
    1. You can use the shortcode even if you don’t use a tracking service
    2. Regard this link for more information.
  2. Display tracking form: You can use this shortcode to create your own Order Tracking page. The shortcode helps you display a tracking form where the customer can enter their order tracking number to track the order.
    [vi_wot_form_track_order]

LOGS

You can check logs of All log file, Import Tracking, Webhooks, Webhook debug, and PayPal debug in the Logs section.

Go to Orders Tracking > Logs

  1. Filter to view and/or download All log files, Import Tracking, Webhooks, Webhook debug, and PayPal debug
  2. Filter the result by date.
  3. Click on View log to check syncing results in detail.
  4. Download the logs if needed.

For example – Check Webhooks and Webhook debug log.

  • Select Webhooks, date, and view the log.

  • Select Webhook debug, date, and view the log.

 

 

 

Below is the list of plugins/3rd parties which are compatible with WooCommerce Orders Tracking:

Plugin Author Compatible feature
WooCommerce Email Template Customizer VillaTheme Fully Compatible
ALD – Aliexpress Dropshipping and Fulfillment for WooCommerce Villatheme Fully Compatible
WooCommerce Order Status Manager WooCommerce Fully Compatible
WooMail – WooCommerce Email Customizer CidCode Fully Compatible
Dianxiaomi – WooCommerce ERP Dianxiaomi Fully Compatible
Polylang WP SYNTEX SMS, Order tracking email
WPML OnTheGoSystems SMS, Order tracking email
WooCommerce PayPal Checkout Gateway WooCommerce Tracking via PayPal
WooCommerce PayPal Payment WooCommerce Tracking via PayPal
PayPal for WooCommerce AngellEYE Tracking via PayPal

When you install and activate the ALD – Aliexpress Dropshipping and Fulfillment for WooCommerce plugin, the ALD dropshipping tab will appear and allow you to manage the tracking info of the Aliexpress orders.

After your Aliexpress orders are fulfilled and the order tracking information is updated, if the above options are enabled, the tracking information will be sent out to the customer.

  • Send email: To configure the email settings, go to the Email tab.
  • Send SMS: To configure the SMS settings, go to the SMS tab.
  • Push tracking info in the Paypal transactions: To configure go to the PayPal tab.

 

This integration will only function if both plugins are installed. After installing these two plugins, navigate to the WooCommerce Orders Tracking plugin to activate and configure the features.
In the settings of Dianxiaomi, you are required to configure the matched carriers
Go to Orders Tracking > Integration 
  • Enable: When you sync Dianxiaomi with your store, enable this option so that tracking data will also be synced automatically.
  • Send email: When tracking numbers are synced with Dianxiaomi, send customers an email to notify about this change.
  • Change order status: When the tracking number is added from Dianxiaomi, change the order to this status.

 

 

 

 

Important note: These new integrations: WordPress REST API;  Tracking meta fields and the plugin helpful functions when making compatible are available since 1.1.0 of premium version only.

1. REST API

a. Authentication

Please refer to WooCommerce’s official documentation https://woocommerce.github.io/woocommerce-rest-api-docs/#authentication

b. Endpoints

    • Set tracking numbers /woo-orders-tracking/v1/tracking/set
Parameter Required Type Default value Description
order_id Yes Integer ID of order that you want to set tracking info for
tracking_data Yes Array List of tracking info that will be set for this order
send_email Bool False Send email if tracking info updated if tracking info updated
send_sms Bool False Send sms if tracking info updated if tracking info updated

 

tracking_data item properties:

 

Attribute Required Type Default value Description
tracking_number String Tracking number
carrier_slug Yes String Slug of carrier that the tracking number belongs to
item_id Integer ID of order item that the tracking is set for. If empty, the tracking number will be set for the order.
quantity_index Integer 1 Only used if $item_id is valid and item quantity is more than 1
add_to_paypal Bool False Will the tracking number be added to PayPal transaction

 

  • Get tracking numbers /woo-orders-tracking/v1/tracking/get

 

Parameter Required Type Default value Description
order_id Yes Integer ID of order that you want to get tracking info
empty_tracking Bool False Whether to return items that do not have tracking info

 

2. Tracking meta fields

*Only applicable when “Manage tracking by” option is set to “Order only – Each order can only have 1 tracking number at a time”

  • Tracking number meta field: _wot_tracking_number
  • Tracking carrier meta field: _wot_tracking_carrier
  • Shipment status meta field: _wot_tracking_status
    If your orders have tracking numbers set for every order item, please use in-built functions.

3. Some functions to use when making compatible with another plugin

  • VI_WOOCOMMERCE_ORDERS_TRACKING_DATA::set_tracking( $order_id, $tracking_number, $carrier_slug, $item_id, $quantity_index, $add_to_service, $add_to_paypal, $send_email, $send_sms);

 

Variable Required Type Default value Description
$order_id Yes Integer ID of order that the tracking is set for
$tracking_number String Tracking number
$carrier_slug Yes String Slug of carrier that the tracking number belongs to
$item_id Integer ID of order item that the tracking is set for. If empty, the tracking number will be set for the order.
$quantity_index Integer 1 Only used if $item_id is valid and item quantity is more than 1
$add_to_service Bool True Will the tracking number be synced with the currently used tracking service
$add_to_paypal Bool False Will the tracking number be added to PayPal transaction
$send_email Bool False Send email if tracking info updated if tracking info updated
$send_sms Bool False Send sms to customer if tracking info updated

 

  • VI_WOOCOMMERCE_ORDERS_TRACKING_DATA::get_carriers( $only_active )

 

Variable Required Type Default value Description
$only_active Bool False Only return active carriers

 

  • VI_WOOCOMMERCE_ORDERS_TRACKING_DATA::get_tracking_numbers( $order_id, $empty_tracking )

 

Variable Required Type Default value Description
$order_id Yes Integer ID of order that you want to get tracking info
$empty_tracking Bool False Whether to return items that do not have tracking info

 

  • VI_WOOCOMMERCE_ORDERS_TRACKING_DATA::get_item_tracking_number( $order_id, $item_id, $quantity_index, $empty_tracking )

 

Variable Required Type Default value Description
$order_id Yes Integer ID of order that you want to get tracking info
$item_id Integer ID of order item that you want to get tracking info. If empty, it will return tracking of the order.
$empty_tracking Bool False Whether to return item detail if it does not have tracking info

 

Extra Information


Thank you for your attention!

If you have any question, please create a topic at our FORUM, we will support within 24 hours.