Tracking Registration Module

Tracking Registration Module

This feature helps you track shipments that were created on other platforms.

1. What is the standard onboarding process for Track Only accounts?

The standard onboarding process for a Track Only account is as follows:

  1. Collect Carrier Details
    • Request the customer to share the list of carriers and their respective API credentials they want to use for tracking.

  2. Carrier Integration
    • Configure and complete the integration for the requested carrier(s) in the eShipz account.

  3. Share Tracking Configuration Details
    • Once the integration is completed, share the required tracking configuration details with the customer. Depending on the carrier, the format may vary:
      • Slug OR
      • Slug | Vendor ID OR
      • Slug | Vendor ID | Service Type
  4. Customer Tracking Registration
    • Using the shared configuration details, the customer will complete the tracking registration via eShipz UI or tracking registration API from their end.

  5. Confirmation
    • Once the customer completes the LR/ tracking number registration, tracking updates will start in the interval of 3 to 4 hours into the eShipz account.

Note: The tracking configuration process varies depending on the carrier. For some carriers, integration must be completed by adding the credentials in carrier configuration page in eShipz account and share the required tracking configuration details (such as Slug, Slug | Vendor ID, or Slug | Vendor ID | Service Type). For some carriers, no integration is required, and customers can complete the tracking registration by using the Slug alone.

2. If the customer has a tracking token, which carrier slug should be used while calling the Tracking Registration API?
Slug|vendor Id

3. If the customer does not have any tracking credentials, what is the recommended approach for Tracking Register API?

Use the slug of the specific carrier available within eShipz carrier library for which the customer has carrier account.

Note:

  • If the tracking registration fails, first verify that the carrier slug does not contain any leading or trailing spaces.
  • If the issue persists, collect the error details and reach out to the Engineering team for further investigation.
  • After the tracking registration is completed successfully, initially monitor the account to ensure tracking updates are being received correctly.
4. Can we share a standard list of supported _offline carrier slugs with customers? If yes, please provide the latest list Carrier and Slugs for whom we don't have tracking token
Please find the complete list of supported carrier slugs using the link provided below.

5. If a customer provides complete carrier credentials (API key, username, password, token, etc.), what is the process to register a new carrier? What information is mandatory?
We request the customer to share the carrier's Tracking API documentation.

If the Tracking API documentation is not available, request the customer to share the carrier's website URL. Our Engineering team will review the details and update us the next step.

6. Under what scenarios should we recommend Push API (Webhook) instead of Pull API?
Ideally, the Push API should be enabled for Delhivery and Blue Dart carriers.

Additionally, based on the customer's workflow and business requirements, a Push API enablement request can also be raised for other supported carriers.

7. What is the standard process for generating and configuring a UUID for webhook registrations?
Kindly follow the steps below:
Step 1: Search for the website using the link provided below
https://www.uuidgenerator.net/
Step 2: Refresh the webpage. A new token is generated each time the page is refreshed.
Step 3: Copy the newly generated token.
Step 4: Paste the copied token into the Webhook Endpoint field.
Sample webhook endpoint: https://app.eshipz.com/webhooks/tracking/delhivery-b2b/UUID

8. What are the prerequisites and validations required before moving a Tracking-Only account to Production?
  1. Create a UAT eShipz account.
  2. Share all necessary carrier slugs with the customer.
  3. Request the customer to register their live LR (Airway Bill) number in the UAT environment using the provided slug.
  4. After registration, verify that tracking updates are working fine in eShipz Account.
  5. If the customer calls the tracking API to pull updates, check the logs to confirm the tracking API is functioning correctly.
  6. If the webhook is enabled, kindly check that the tracking details are being pushed correctly as well.




    • Related Articles

    • How to do tracking registration?

      Step 1: Log in to your eShipz account. Step 2: Navigate to settings. Step 3: Click on Upload and Update Tracking, refer image. Step 4: Download the Excel file template by clicking on "Excel File Template", refer image. Step 5: Open the downloaded ...

    • How to upload tracking or do tracking registration in new UI?

      This feature helps you track shipments that were created on other platforms. Step 1: Login to your eShipz account. Step 2: Navigate to Fulfillment > Shipment Step 3: Click on Upload Tracking. Step 4: Download the Excel file template. Step 5: Fill in ...

    • How to check tracking status of a Shipment?

      eShipz allows you to track all your shipments(if you have opted for the tracking services), at one place. Instead of logging into multiple carrier accounts to track the status of your shipment, simply login to your eShipz account and check the ...

    • What is POD module in new UI?

      1. What is POD? POD stands for Proof of Delivery. It is a digital document or image confirming that a shipment was successfully delivered to the recipient. The eshipz POD module lets you view, filter, verify, download, and manage POD documents for ...

    • How to Update the Latest Tracking Status in the UI

      This article explains us how to update the latest tracking status in case of a tracking status mismatch between the carrier portal and eShipz. For example, if a shipment is marked as 'Delivered' in the carrier portal but still shows as 'In Transit' ...