Integration Guide

This part of the documentation will guide you through the steps of integrating with the Ingrid tracking solution. It consists of two parts:

1. installing and displaying Ingrid Delivery Tracking Widget on your page,
2. using Ingrid hosted Tracking Page,
3. providing orders for Ingrid to track.

Installing Delivery Tracking Widget

Tracking Widget should be embedded in a site controlled by Merchant. The most common scenario is a dedicated tracking page within Merchant's domain and built by Merchant specifically to host Tracking Widget. A link to this tracking page with an embedded Tracking Widget is subsequently given to the Customer.

Flow for the Merchant

1. Load Tracking Widget code:

<script src="https://cdn.ingrid.com/delivery-tracking/bootstrap.js"></script>

2. Select which element of the page should be the widget container and give it a unique id. For example:

<div id="delivery-tracking-widget"></div>

3. After the script is loaded, initialize Tracking Widget using JavaScript. To initialize search mode use the renderSearchMode method:

window.IngridDeliveryTrackingWidgetApi.renderSearchMode({
  containerId: string,
  locale: string,
  siteId: string,
});

4. If you want to render private mode use the renderPrivateMode method:

window.IngridDeliveryTrackingWidgetApi.renderPrivateMode({
  containerId: string,
  locale: string,
  siteId: string,
  identifier: string,
  contact: string,
});

5. After calling the respective method to render mode Tracking Widget should appear on the page

IngridDeliveryTrackingWidgetApi

Search mode

IngridDeliveryTrackingWidgetApi.renderSearchMode function expects as argument an options object with 2 required properties:

• containerId: HTML id of the container to inject the tracking widget into
• siteId: Id of the site (use IMP to get your siteId)

Optional properties are:

• locale: Adjusts the language - by default, the widget will use en-US. See Supported Languages.
• prefillIdentifier: either tracking number for parcel or external id for order. Used to prefill the form
• prefillContact: either end customer telephone number or email. Used to prefill the form

Private mode

IngridDeliveryTrackingWidgetApi.renderPrivateMode function expects as argument an options object with 4 required properties:

• containerId: HTML id of the container to inject the tracking widget into
• siteId: Id of the site (use IMP to get your siteId)
• identifier: either tracking number for parcel or external id for order
• contact: either end customer telephone number or email

Optional property is:

• locale: Adjusts the language - by default, the widget will use en-US. See Supported Languages.

Passing arguments to IngridDeliveryTrackingWidgetApi

It is up to you how you pass arguments to IngridDeliveryTrackingWidgetApi but we recommend that you take identifier and contact from query parameters.

For example, the link to your site can look like this:

https://tracking/?identifier=<TRACKING_NUMBER>&contact=<CONTACT>

Then you can extract identifier and contact from query paramaters:

const params = new URLSearchParams(window.location.search);
const identifier = params.get("identifier");
const contact = params.get("contact");

// for search mode
window.IngridDeliveryTrackingWidgetApi.renderSearchMode({
  containerId: "delivery-tracking-widget",
  siteId: "YOUR_SITE_ID_FROM_IMP",
  prefillId: identifier,
  prefillContact: contact,
});

// or for private mode
window.IngridDeliveryTrackingWidgetApi.renderPrivateMode({
  containerId: "delivery-tracking-widget",
  siteId: "YOUR_SITE_ID_FROM_IMP",
  identifier,
  contact,
});

Ingrid hosted portal and page

You can use Ingrid hosted portal and page by going into Ingrid Tracking Portal. Portal consists of two parts:

1. Portal - is a place where end-user can search for their packages
2. Page - is a place where the end-user will get information about a specific package

Flow for the merchant

If you need to send the end customer to the Ingrid portal you can use the following link:

https://tracking.ingrid.com/

You can add two query parameters (prefillContact and perfill_id) to the URL if you want to prefill search on the tracking portal

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

Link to tracking portal can be localized by adding locale after .ingrid.com part:

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

Link to public view is created by taking Ingrid Transport Order Id (TOS id) and adding /order/<TRANSPORT_ORDER_ID> to URL:

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

Link to public Tracking page can be localized by adding locale after .ingrid.com part:

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

Link to private Tracking page can be generated using our API:

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"
}

Parameter locale will adjusts the language of Page. See Supported Languages.

You can also specify tracking number in body 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"
}

In response you will get full link with token to Ingrid Tracking Page:

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"
}

Supported Languages

The following locales are supported:

• Czech - cs-CZ
• Danish - da-DK
• Dutch - nl-NL
• English (Australia) - en-AU
• English (Canada) - en-CA
• English (Ireland) - en-IE
• English (United States) - en-US
• English (Great Britain) - en-GB
• Estonian - et-EE
• French - fr-FR
• Finnish (Finland) - fi-FI
• Finnish (Sweden) - fi-SE
• German - de-DE
• Greek - el-GR
• Croatian - hr-HR
• Icelandic - is-IS
• Italian - it-IT
• Japanese - ja-JP
• Korean - ko-KR
• Lithuanian - lt-LT
• Norwegian Bokmål - nb-NO
• Norwegian Nynorsk - nn-NO
• Norwegian - no-NO
• Polish - pl-PL
• Portuguese - pt-PT
• Russian - ru-RU
• Slovak - sk-SK
• Slovenian - sl-SI
• Spanish - es-ES
• Swedish (Finland) - sv-FI
• Swedish (Sweden) - sv-SE

Providing orders to track

If you are using an external system for booking your orders you can still track them using Ingrid Tracking Widget. The one thing we need you to do to is to post the tracking number you got from your external booking system and specify the order number (external_id or tos_id) together with the carrier product that was used for booking.

To send an externally booked order to the Ingrid system you should do a POST request to v1/events_gateway/events.registerTrackingNumber.

POST v1/events_gateway/events.registerTrackingNumber HTTP/1.1
Host: api.ingrid.com
Accept: application/json
Content-Type: application/json
Authorization: Bearer base64-encoded-api-token

{
  "tracking_number": "BST000185540",
  "external_id": "592978",
  "carrier_product_ref": "postnord-mypack-collect",
  "direction_type": "OUTBOUND"
}

POST v1/events_gateway/events.registerTrackingNumber HTTP/1.1
Host: api.ingrid.com
Accept: application/json
Content-Type: application/json
Authorization: Bearer base64-encoded-api-token

{
  "tracking_number": "BST000185540",
  "tos_id": "01G51NDWW1NCPNV2MV5WMB0H6A",
  "carrier_product_ref": "postnord-mypack-collect",
  "direction_type": "OUTBOUND"
}

Specifying a concrete carrier product used for booking can be tricky as each party or system usually operates based on self-made identifiers. That is why Ingrid created a mechanism that makes the integration easier by allowing any integrator to reuse its own internal naming while being precise about the carrier product - see carrier product mapping.

direction_type is an optional field, that holds information about the initial package direction. This information helps us to show you the most accurate list on MAD and also helps to serve the best tracking experience for your customers. This field is especially important when you are registering not only outbound parcels but also return one - e.g. you are booking a return shipment and want to register it in our system.

Carrier product mapping

carrier_product_ref is a carrier product reference from an external system that is mapped in Ingrid and indicates which carrier product has been used.

This reference can be any string, but it should be the same for all orders booked with the same carrier product.

Each time you start using a new carrier product, it needs to be mapped in order to enable tracking for it. Mappings can be created in the Ingrid Merchant Platform (Delivery Tracking > Features) and there are two ways to do it - you can use one of the carrier products already defined by Ingrid, or create a custom configuration.

Using existing carrier product

This is how the configuration window looks like:

Here you can enter your carrier product reference and select the corresponding carrier product. After selecting your desired carrier product, you will be able to see the status of the Ingrid tracking integration for this product - is it available and does it need some additional configuration. Even if it's not, don't worry - in that case, Ingrid will show the carrier's tracking links instead.

Creating custom mapping

If your desired carrier product isn't contained in Ingrid's list of available products, or if you want to show custom tracking links, you may want to create a custom mapping. Here is how to do it:

If you need, you can add separate URLs for every locale.

Custom events

Custom events are localized messages that you can use to provide more information to your customers regarding what is currently happening with their parcels. Some example custom events may be:

• Package needs more time to be assembled.
• Package is waiting for pick up by the carrier.

Creating custom events

Custom events can be created in the Ingrid Merchant Platform (Delivery Tracking > Events).

After event creation, it should appear in the table.

You can edit those and provide translations of your custom events.

Using custom events

To attach a custom event to a package, you should request a POST to service-events-gateway.

POST v1/events_gateway/events.publishTrackingEvent HTTP/1.1
Host: api.ingrid.com
Accept: application/json
Content-Type: application/json
Authorization: Bearer base64-encoded-api-token

{
    "tracking_number": "BST000079234",
    "tracking_status": "CUSTOM",
    "occurred_at": "2006-01-02T15:04:05+07:00",
    "custom_event_type_id": "delayed-package"
}