Use our AI-assisted tracking to maximize your precision

You know the story. Retailers blame transporters. Transporters blame retailers. And consumers just want their package on time.
With a high level of precision in your tracking, you can avoid a lot of customer frustration and spend less time on customer support.
We have built our tracking functionality to be both minimal, so that it is easy to get started with, and powerful, so that you never need to be surprised by delays again.



Get your API credentials and Scope login from your Skrym contact. Don't have one? Reach out to us at 


Create the order with 


Add one or more shipments to the order with 


Go to  or call  to verify your shipment is being tracked.




Tracking

Events are notifications that transporters provide from the time of booking until the shipment is considered done. Skrym receives events from transporters in one of two different ways:
 
Getting events by **Webhook** means that Skrym will subscribe to the transporter's events on your behalf.
As soon as the transporter has a new event, it will notify Skrym who stores and parses
the event.
This is the preferred and more modern way of sharing tracking information, and tends to be the standard among
newer transporters.
Skrym also enables you to use this mechanism to subscribe to all your events (regardless of transporter) - you can read more on the  page.


Most transporters still do not provide webhook support, which means Skrym has to call the transporter's tracking API with regular time intervals in
order to know what is going on with a shipment.
Think of us as the kid in the back of a car asking "Is it there yet?" on your behalf.

When we receive an event, we immediately store the original transporter event in our system so that in case of confusion/error or any other reason we can always go back and check what we originally received.

This is particularly important as many transporters delete event data for shipments older than 6 months.
Skrym provides a set of default event types that we use to categorize the events we receive. These are:
| Skrym Event | Description |
| --- | --- |
| arrival | The shipment has arrived at a checkpoint |
| delay | The shipment is delayed |
| error | An error has occurred with the shipment |
| delivered | The shipment has been delivered |
| notification | A notification has been sent to the recipient |
| departure | The shipment has left a checkpoint |
Skrym maps the transporter's event to one of these types. This is done to ensure that we can provide a consistent experience across all transporters.

Each shipment has a status. Some events make the status change, while some other does not. A status can be one of four values:








When Skrym receives a transporter event that indicates an error, the shipment's status tends to be changed to 
Notifications events, such as when a text reminder has been sent to the recipient, will never lead to a change in status



Anatomy of an Event
The struct for a skrym event is defined by a few fields.
Some data about when the event was created and what the event is tracking (e.g what shipment it is about). It also contains some data regarding what the event means. That data we store in the field EventAspect.

An event aspect contains information needed to understand what the event "means". This includes data points such as
direction, location and event type.

Once the OpenAPI client generation improves enough to start fetching information about substructs,
we should replace the below table to instead just use this model.


|Field| Usage|
|---|---|
|Type| A pre-defined type of event (e.g arrival, delay, error, delivered)|
|Checkpoint*| A abstract place from which the event has occurred, a terminal or maybe while in transit|
|Message*| If the event contains any specific information to clarify how/when/why/what the event is/means|
|Next*| The same structure as the checkpoint, but used to say if the event can predict the next "place" we should expect the shipment to arrive at|
|Direction*| This field is to tell us if the direction of the shipment has changed, maybe the event is a notification of cancellation so that the order has to return|
* - optional field'
 

Checkpoint and Next are two fields in the event aspect. We use these to indicate what type of place the event has happened at, and what we expect the next event to be (next). 

If we get enough information to also know where the  is, we store a reference to this location so we can accurately recreate the physical journey of a shipment.


Events

Define shipment lifecycles with milestones and conditions

A Shipment journey is a way of defining the lifecycle of a shipment.
The journey is defined by a set of milestones and their conditions that are used to determine the current state of the shipment.
This can be very powerful as it allows you to define the journey of a shipment in a very flexible way.
As an example, you can define a shipment journey for international shipments that have to go through customs and another journey for domestic shipments that do not have to go through customs.
Anatomy of a Shipment Journey
<MermaidChart
title="Shipment Journey Anatomy"
dateFormat="YYYY-MM-DD"
chart={  gantt      section Journey     Journey Initialization   :a1, 2024-07-01, 1d     Journey Milestones       :milestones, after a1, 6d     section Milestones     Milestone 1              :m1, after a1, 2d     Milestone 2              :m2, after m1, 2d     Milestone 3              :m3, after m2, 2d     section Conditions     Condition 1              :c1, after a1, 2d     Condition 2              :c2, after m1, 2d     Condition 3              :c3, after m2, 2d     Condition 4              :c3, after m2, 2d     section Events     Event 1 for Milestone 1  :e1, after a1, 1d     Event 2 for Milestone 1  :e2, after e1, 1d     Event 1 for Milestone 2  :e3, after m1, 1d     Event 2 for Milestone 2  :e4, after m1, 1d     Event 3 for Milestone 2  :e5, after e3, 1d     Event 1 for Milestone 3  :e6, after e5, 1d     Event 2 for Milestone 3  :e7, after e6, 1d     Event 3 for Milestone 3  :e8, after e6, 1d}
/>
A Shipment Journey is a collection of milestones, conditions, and events that define the lifecycle of a shipment.
When a new shipment is created, it is assigned a journey that defines the milestones that the shipment has to go through and the conditions that must be met for the milestones to be considered reached.
Each time an event is received for the shipment, the journey is evaluated to determine if any of the milestones have been reached.
Milestones
Milestones are the key points in the shipment journey. They have a name, a description, and a set of conditions that must be met for the milestone to be considered reached.
They can be used to create rulesets that define the conditions for sending notifications or triggering actions.
For example, you can define a milestone for when the shipment has been picked up by the carrier, and another milestone for when the shipment has been delivered to the recipient.

Conditions are the rules that must be met for a milestone to be considered reached. They can be based on the  or Shipment time. 
For example, you can define a condition that checks if the shipment has been picked up by the carrier by looking at the events that are received from the carrier.


The milestones within a journey can each have a sequence number indicating its order within the journey. However, it is possible to have multiple milestones within the same sequence, allowing for different scenarios to be handled within the same step of the journey. For example, both "Delivered" and "Delivered Early" can be configured as milestones within the same sequence.
This is supported by the displayOrdering field in the milestone object.
Handling Milestones Without a Specific Sequence
Not all milestones need to be part of a specific sequence. For instance, an "Order Damaged" milestone might be relevant at any point during the shipment journey, regardless of the sequence. Both the sequence and displayOrdering fields are optional, meaning milestones can be defined to happen independently of the journey's linear progression.


In some cases, a milestone might represent the final step in the journey, after which no further milestones are expected to be completed. For such cases, the final field can be used to mark a milestone as the concluding point of the journey. Examples include milestones like "Order Cancelled" or "Order Delivered," where the journey ends upon reaching this milestone.

Below you can read the description for each terms used in the Shipment Journey:
| Term | Description |
| --- | --- |
| Journey| A complete timeline consisting of multiple Milestones and Conditions. |
| Milestone | Major steps a shipment can take along its journey Example: The shipment reached to the customs in Germany. |
| Condition | Set of logical evaluations that will be either true or false, determining if the milestone is reachedExample: The shipment is cleared from Customs |

Onboarding
Shipment Journey and milestones can be used out of the box with Skrym.
To get started, Skrym provides a set of predefined milestones that can be used to define the journey of a shipment:
| Milestone | Description |
| --- | --- |
| Order Received | Warehouse received notification about the order. |
| Order Sent | Warehouse handed over the package to carrier. |
| Order Delayed |in transport: Transporter sent delay event. |
| Order Delivered | Package delivered to the final location. |
These milestones are assigned to you by default during onboarding and Skrym creates a default journey. That means you can start using them right away without any additional setup.
You can simply create a new shipment and assign the predefined journey to it. Skrym will then evaluate the journey each time an event is received for the shipment and update the status of the shipment accordingly.
Of course, these milestones can be fully customized to fit your specific needs, or you can create your own milestones from scratch. Read more about this in 

Shipment Journey


The Skrym delay inference model is still in training, which means you should for the time being
be careful with any automation related to Skrym events identifying a shipment as delayed.

Shipping data is inherently difficult to make sense of. That's why Skrym is applying
statistical inference and ML models to help identify shipments that are likely to be delayed.
Our goal is to give you information as early as possible when a shipment will be delayed,
so that you can work with proactive communication to the recipient to prevent angry calls to
customer service.
How does it work?
Skrym uses a variety of data points connected to the time and date of the shipment, as well as:

Aggregated statistics of the transporter
Average delivery times between major transport hubs
Expected event chains and notification spans


Delay prediction

Supported transporters
For some transporters, you need to complete some additional steps in order for Skrym to have access to the events.
In the table below, you can see if any particular steps are required for your transporters.
| Transporter                                                         | Steps                                                                                                                                                                                                                                                                                                                                                                                                          |
| ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <OrganizationChip name={'postnord'} text="PostNord" size={26} />                    | No steps required.                                                                                                                                                                                                                                                                                                                                                                                             |
| <OrganizationChip name={'budbee'} size={26} />                      | You need to add Skrym to the list of destinations for the event subscriptions by following the steps in the .  The URL you specify should be https://api.skrym.com/tracking.BudbeeTrackingWebhook and you need to add a HTTP Basic authentication with a username and password that Skrym can provide you with. |
| <OrganizationChip name={'earlybird'} text="Early Bird" size={26} /> | No steps required.                                                                                                                                                                                                                                                                                                                                                                                              |
| <OrganizationChip name={'instabox'} size={26} />                    | Skrym needs to be set as a receiver for Instabox events. This is something we are happy to help you setup together with your contact at Instabox.                                                                                                                                                                                                                                                                                                                                                                                              |
| <OrganizationChip name={'dbschenker'} text="DB Schenker" size={26} />                  | No steps required.                                                                                                                                                                                                                                                                                                                                                                                               |
| <OrganizationChip name={'bring'} size={26} />                       | No steps required.                                                                                                                                                                                                                                                                                                                                                                                              |
| <OrganizationChip name={'posti'} size={26} />                       | No steps required.                                                                                                                                                                                                                                                                                                                                                              |
| <OrganizationChip name={'airmee'} size={26} />                      | Skrym needs to be set as a receiver for Airmee events. This is something we are happy to help you setup together with your contact at Airmee.                                                                                                                                                                                                                                                                                                                                                                                    |
| <OrganizationChip name={'ica'} size={26} />                         | Skrym needs to be set as a receiver for ICA events. This is something we are happy to help you setup together with your contact at ICA.
| <OrganizationChip name={'dhl'} text="DHL" size={26} />              |                                                                                                                                                                                                                                                                                                                                                                                               |                                                                                                                                                                                                                                                                                                                                                                                         |

Integrations

Display tracking information on your website

To make it easy for you to help your customers track their shipments, we have created a widget that you can embed on your website.

The widget is currently in beta and may be subject to changes in the future.

Implementation
1. Add the helper script to your website
To use the widget, you need to add the following script to your website.
This script will handle the communication between the widget and your website.
<script src="https://tracking-widget.skrym.com/client-script.js" defer></script>

2. Get the URL for the widget
The widget is meant to be implemented as an iframe on your website.
To get the URL to use for the iframe, you will first need to make a request to the following API.


You need to be  with your API key to use this endpoint. To avoid exposing your API key to the public, please ensure that you make this request from your backend and not the client's browser.

This URL will include the necessary authentication to display the tracking information in the widget.
The authenticated session is valid for 24 hours, after which a new widget URL is needed.
3. Embed the widget on your website
Once you have the URL, you can embed the widget on your website using an iframe.
<iframe src="URL_FROM_API" id="skrym-tracking-widget"></iframe>

With the script added above, the iframe will be automatically resized to fit the content of the widget.
All you need to do is to set the width as you desire, and the height will be adjusted dynamically.

By default, an iframe has a border around it. This can easily be removed by setting the CSS property `border` to `none`.
If you still want a border on the iframe, you can style it as you like using CSS. However, please ensure that the box-sizing CSS property is set to content-box, as it might otherwise break the auto-height functionality of the widget.

Configuration
To get the widget to look and work as you want it, there are a few configuration options available.
To learn more, see the .

Widget

This page covers how you can set your tracking preferences in Skrym.
Automatic archival of shipments
In cases where we for some reason do not receive any events for shipment for a long time, we support automatic archival of shipments after a certain period of time. Once archived, we will stop polling the transporter for new events.
However, if we receive an event for an archived shipment via an webhook or our API, we will still handle it as usual.
This is useful if for example a test order slipped into production, or if a shipment was cancelled without us being notified.
This feature is opt-in, and can be enabled on .
You are able to set the number of days of inactivity after which a shipment should be archived.

Preferences

On this page you can explore the different APIs we provide for our tracking functionality.
If you have ideas on additional APIs or changes that would make things easier or better for you, we would love to hear from you at 

  
    Add tracking
    Fetching
    Statistics
    Custom events
  
  
    

### Initialize an order

To create an order, use the InitializeOrder endpoint. It's recommended to call this endpoint immediately after an order is confirmed.
When making the request, you will provide any relevant order references and additional metadata.
These references allow you to later retrieve order details, including shipment information, or to associate custom events with the order.

Add shipments to the order
Once a shipment has been booked, you can link it to an existing order by calling the AddShipmentsToOrder endpoint.
This requires details about the shipment, such as the transporter, transport method, and tracking reference.
It also allows you to provide information about the parcels in the shipment.
If not provided, Skrym will attempt to infer this information from the transporter.
Once the shipment is added, Skrym will monitor transporter updates and provide you with relevant tracking information.

Add more references to the order
If you need to add more references to an order, use the AddOrderReferences endpoint.
Provide an existing reference from the order along with the new reference(s) you wish to associate.

</TabPanel>
<TabPanel>

### Get an order and it's shipments

To get information about an order, you can call the GetOrderInformation endpoint.
This will include all the shipments and references that are associated with the order.

The trackedShipmentId can then be used to fetch tracking information for a specific shipment.
This can be done by calling the GetTrackedShipmentAndInfoByID endpoint.
This includes all the parcels, events and other information that Skrym has about the shipment.

Get single shipment by tracking reference 📦
You can also fetch tracking information for that shipment using it's tracking reference. As the response body is quite exhaustive,
we recommend you to reach out if you have any questions regarding a particular field.

Get multiple shipments 📦📦📦
It is also possible to fetch information regarding all your shipments and provide a filter.

</TabPanel>
<TabPanel>

Daily Counts
To provide a basic overview, Skrym offers daily counts of all of your shipments' statuses. This means that you can see how many of
your shipments were flagged with one of Skrym's tracking statuses each day:












Latest Counts
It is also possible to fetch only the most recent counts for each status.

    
    
### Custom events
You can add your own tracking events to the shipment to enhance the amount and quality
of information available to you and your customers. Common use cases for this include:

Adding pre-transporter events such as warehouse pick & pack progress
Adding delivery-related complaints from customers as events to better understand returns


{/* TODO: Not supported yet, update when available. /}
{/ To make things easier, you can also set up a default starting event for your warehouse.
This will be generated automatically when you initialize tracking for an order and you include an organization location identifier in your call to the TrackShipment endpoint. */}
</TabPanel>

  
