Throughout This Page
You can jump to the specified sections by clicking on these titles.
Overview
Integrating your operational systems with a shipping API service can provide you with easy access to real-time shipment tracking information. The Shipping API can help you retrieve this information effortlessly. With a dedicated function, the Shipping API lets you monitor shipments from their despatch initiation to their final delivery destination. This documentation explains how to configure and deploy this tracking feature successfully in your system.
Dashboard and Enabling Shipment Tracking
The shipping module offers an inherent shipment tracking capacity, accessible through the dedicated Tracking Dashboard interface. To initiate access to the Tracking Dashboard, log into your account. The default presentation will redirect you to the Shipping Dashboard upon successful login.
If the Tracking Dashboard is not immediately visible upon account login, it indicates that your account's tracking feature has yet to be activated. In such cases, activation becomes a prerequisite and must be completed before utilisation.
To activate the tracking feature, navigate to the "My Account" button within the left-hand menu. Locate the "Additional Addons" section highlighted within the interface. Here, the feature configuration resides. Utilise the provided button to toggle the activation state, turning the tracking functionality on or off.
Upon successful activation, return to the dashboard through the left-hand menu. You will find two distinct buttons in the upper-right corner: "Shipping Dashboard" and "Tracking Dashboard."
With activation complete, accessing the Tracking Dashboard becomes feasible by selecting the relevant button, enabling seamless engagement with the comprehensive tracking capabilities.
Shipment Tracking Dashboard
With access successfully established to the Tracking Dashboard, you can shift your focus to effectively tracking shipments within the system.
The visual representation below provides an insightful display of shipment details, predominantly encompassing today's shipments by default. To inspect shipments from alternative dates, the date picker positioned on the upper right-hand side of the screen proves to be a valuable tool. This feature offers a dual function: the ability to manually select dates from the calendar and the convenience of employing rapid date picker options, each offering predefined time spans such as "Today," "Yesterday," "This Week," "Last Week," and others.
Upon date filtering, a comprehensive presentation of tracking results materialises. These results encapsulate various aspects ranging from the quantity of despatched shipments to the corresponding statuses. These statuses encompass categories such as "Delivered on Time," "Late Delivery," "Exception," and "Failed."
The "Shipments Per Hour" graphical chart is noteworthy among the displayed information, which visually portrays shipment distribution across the selected time interval. Each shipment status is distinguishably colour-coded. Additionally, the dashboard houses two supplementary charts below: "Delivery Performance by Region" and "Active Deliveries by Tracking Status."
Chart Insights: Dive into the "Shipments Per Hour" chart to identify peak shipping times. Adjust your operations to manage high-demand periods more effectively.
An effective filtering bar is nestled on the left side of the date filter. This feature empowers users to precisely narrow down the displayed shipments based on personalised criteria. Notable options within this filtering bar encompass:
- Couriers: Facilitates the selection of specific couriers for tracking purposes.
- Friendly Service Name: Enables searches for shipments linked to specific courier presets via the Friendly Service Name filter. Service IDs or preset names can be input here. For example, the "IPX-DPDND" Service ID or the corresponding name "DPD Parcel Next Day" can be utilised. Reference to the "How to Add a Courier Service" document can provide further insights into courier services and presets.
- API Account: Allows the selection of API accounts for tracking, which is particularly useful when multiple accounts are in use.
- To Country: Offers the ability to focus on shipments destined for particular countries.
- Tracking: Permits the tracking of shipments with specific statuses, including but not limited to "Booked," "Collected," and "Delivered."
- On-Time/Late: Facilitates tracking shipments with defined time-based statuses such as "Expected Late," "Expected On Time," "Delivered Late," or "Delivered On Time."
These filtering options allow users to tailor their tracking experience to align with their specific requirements.
