Documentation

Ingrid Hosted Tracking Page and Tracking Portal

Ingrid Hosted Tracking offers a seamless and efficient alternative to the Ingrid Delivery Tracking Widget. This integrated solution empowers Customers with real-time delivery updates, ensuring they stay informed at every step of their order journey. The Ingrid Hosted Solution is built around two key components:

Tracking Portal: A centralised hub for End Customers to effortlessly search for and track their orders.

Tracking Page: A dedicated page where Customers can access detailed information about their parcels - including delivery status, ETA, and any relevant updates - similar to the Tracking Widget. Following a successful search, Tracking Portal redirects Customers to Tracking Page.

Using Tracking Portal

To direct End Customers to the Ingrid Tracking Portal, simply provide them with the following link:

https://tracking.ingrid.com/

To pre-populate the search field on the Tracking Portal with specific contact information and parcel identifier, include two query parameters (prefillContact and prefillIdentifier) in the URL:

https://tracking.ingrid.com/?prefillContact=<EMAIL>&prefillIdentifier=<ORDER/TRACKING NUMBER>

The URL to Tracking Portal can be localized by adding a locale after .ingrid.com part:

https://tracking.ingrid.com/<LOCALE>/

Tracking Portal refill example

Using Tracking Page

The Ingrid Tracking Page offers two ways for customers to access their delivery information.

  1. Public View:
  1. Private View:

Public View is ideal when you prioritise faster integration and less development effort, with a downside of requiring an extra step from the End Customers. Private View is ideal when you are seeking a truly frictionless experience for customers, prioritizing their convenience and data privacy.

Public View

A link to the public view can be constructed simply by taking Ingrid Transport Order ID (TOS ID) and adding /order/<TRANSPORT_ORDER_ID> to the base Tracking Portal URL:

https://tracking.ingrid.com/order/<TRANSPORT_ORDER_ID>

A public URL can be localized by adding locale after .ingrid.com part:

https://tracking.ingrid.com/<LOCALE>/order/<TRANSPORT_ORDER_ID>

Private View

A direct link to private Tracking Page view can be obtained using GenerateTrackingPageLink endpoint:

POST v1/delivery_tracking/generate_tracking_page_link
Host: api.ingrid.com
Accept: application/json
Content-Type: application/json
Authorization: Bearer <BASE64-ENCODED-API-TOKEN>

{
"locale": "en-US",
"order_id": "592978",
"site_id": "11756e4a98c64fa9a9c5d627fd88a236"
}

order_id can be populated with either external_id or TOS_ID. locale adjusts the language of Tracking Page. See Supported Languages.

You can also specify tracking_number in the request:

POST v1/delivery_tracking/generate_tracking_page_link
Host: api.ingrid.com
Accept: application/json
Content-Type: application/json
Authorization: Bearer <BASE64-ENCODED-API-TOKEN>

{
"locale": "en-US",
"tracking_number": "BST000079234",
"site_id": "11756e4a98c64fa9a9c5d627fd88a236"
}

Either tracking_number or order_id can be added to JSON request to the end of obtaining a private Tracking Page URL. Passing both of them at the same time will result in an error.

In response you will receive localised link to the Ingrid Tracking Page in the private view:

HTTP/1.1 200 OK
Date: Tue, 10 May 2022 13:25:51 GMT
Content-Type: application/json

Connection: close
Vary: Accept-Encoding
x-trace-id: D20220314132550W4T98CK0A6AEQ72X

{
"tracking_link": "tracking.ingrid.com/en-US/<TOKEN>"
}

Last updated: Mon, Jun 24, 06:15 AM