Skip to main content

Common Scenarios

Here are a few standard scenarios that should give you a good overview of the various integration options. Those are just examples, so feel free to dive into the different end-points as well to have our API meet your precise requirements.

Using webhooks is the most efficient to get timely tracking updates on your shipments:

  1. In your system, create an endpoint to receive webhooks as described in the Webhooks section.
  2. In your Ship24 Dashboard, set the webhook URL pointing to your endpoint.
  3. Start tracking your shipments using Create a tracker POST /v1/trackers for each of your shipments. Tracking results will be pushed to your endpoint automatically.

Fetch tracking updates on your shipments by regularly calling our API​

An alternative to webhooks is to fetch tracking results regularly from our system. This method is less efficient compared to webhooks as your system will have to call regularly our system, for each shipment, to get updates.

  1. Start tracking your shipments using Create a tracker POST /v1/trackers for each of your shipments.
  2. Save the trackerId Ship24 allocated to your Tracker
  3. Get tracking results using Get results for an existing tracker GET /trackers/:trackerId/results for each of your shipments.

Get immediate tracking on a shipment​

This method applies if you wish to get tracking results on a shipment directly during the very first API call to Ship24. However, as Ship24 has to search and fetch tracking data from couriers synchronously during the first call, response time will be ranging from a few seconds to one minute. For some couriers, this synchronous fetching may not be supported, but tracking results will be available in subsequent calls.

  1. Start tracking a shipment and get synchronous tracking results using Create a tracker and get results POST /v1/trackers/track. This end-point will directly return tracking results.
  2. Get subsequent tracking results by calling again the same endpoint with the same parameters as point 1.

View and manage your shipments on a visual dashboard​

Our Shipment Tracking Dashboard allows you to monitor all your shipments tracked by our API, check their status and events, add and import shipments manually, and report any issues to our support team in just two clicks! This Shipment Tracking Dashboard is available as an option of your Tracking API plan, for which you can opt-in when subscribing to a plan, or anytime afterward.

Dashboard Tracking Shipments