Skrym LogoAPI

API

All our tracking endpoints

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 dev@skrym.se

Add tracking

When to call the Tracking API?
sequenceDiagram autonumber participant Consumer as Consumer participant Retailer as Retailer participant Skrym as Skrym Consumer->>+Retailer: Places order Retailer->>+Skrym:Initialize order Note over Retailer: Pick & Pack Note over Retailer: Print label Retailer->>Skrym:Add shipments to order Note over Skrym:Skrym fetches and <br/> analyzes transporter events Skrym-->>-Retailer:Tracking events Retailer-->>Consumer:Order updates Retailer->>-Consumer:Order delivered

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.

postapi.skrym.com/tracking.InitializeOrder

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.

postapi.skrym.com/tracking.AddShipmentsToOrder

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.

postapi.skrym.com/tracking.AddOrderReferences

Fetching

Consumer facing tracking

To provide tracking information to your customers, you can call the GetTrackedORder endpoint, which does not provide all the raw data but rather provides the same data that Skrym uses to populate the tracking widget.

Empty shipment before booking

Note that before a shipment has been booked for an order, you will get an empty shipment but will still have all relevant order journey information.

postapi.skrym.com/GetTrackedOrder

Get an order and its 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.

postapi.skrym.com/tracking.GetOrderInformation

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.

postapi.skrym.com/tracking.GetTrackedShipmentAndInfoByID

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.

postapi.skrym.com/GetShipment

Get multiple shipments 📦📦📦

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

postapi.skrym.com/tracking.GetAllShipments

Statistics

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:

  • OK
  • DELAYED
  • PROBLEM
postapi.skrym.com/tracking.GetShipmentStatusCountHistory

Latest Counts

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

postapi.skrym.com/tracking.GetShipmentStatusCount

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
postapi.skrym.com/tracking.UpsertEvent