How to use Tracking URL formats [Step-by-Step guide]

When needed, you might need to set Tracking URL Formats for technical purposes. These can be set up at the Carrier Baseline Account level, and can be used by connected Billing Accounts, but also used and obtained and interacted with via API (Blackbox) connections.

This article is divided into the following sections:

1. Configure Tracking URL Format
2. Use Through Billing Accounts in techSHIP
3. Use Through API Blackbox Connections

NOTE: This feature is limited to carriers supporting it.

I. CONFIGURE TRACKING URL FORMAT

1. Access Maintenance and select Carriers.

2. Click the desired Carrier.

3. Click the Accounts tab.

4. Click the Edit button for the desired account.

5. Enter the Tracking URL Format using the {TrackingNumber} variable.

NOTE: Samples of Tracking URL Formats targeting specific Carrier URLs and using the {TrackingNumber} variable are:

• Canpar: https://www.canpar.com/en/tracking/track.htm?barcode={TrackingNumber}
  
• Purolator: https://www.purolator.com/en/shipping/tracker?pins={TrackingNumber}
• Canada Post: https://www.canadapost-postescanada.ca/track-reperage/en#/details/{TrackingNumber}
  

These Tracking URL Formats are defined by each carrier. The examples above are only samples and may change over time. For other carriers, please check their official documentation or request the correct format from the carrier's support team.

6. Press Save.

II. USE THROUGH BILLING ACCOUNTS IN TECHSHIP

To do so, there are no additional steps other than setting up and configuring the Billing Accounts at the Client level, bound to the Baseline Account with the Tracking URL Format.

As orders get handled through the accounts, whenever related, the Tracking URL Format will be used as set up previously.

III. USE THROUGH API BLACKBOX CONNECTIONS

For clients interacting with techSHIP via API, the tracking URL is automatically generated and returned after a shipment is successfully created.

After making a successful Create Shipment API call, you will find the TrackingUrl field in the response. It contains the complete, ready-to-use tracking link for that specific shipment. This is the final URL that you can provide to your end customers.