Tracking

Tracking is a key feature of the Evership platform — it allows you to monitor the status of shipments in real time. The Tracking APIs enable you to programmatically fetch tracking logs and the latest status updates for your shipments.

On this page, we’ll explore the endpoints available for retrieving full tracking histories (tracking-log) and current tracking statuses (tracking-status). You can use these endpoints to display delivery progress to customers, trigger updates in your system, or track service performance.

Introduction

The tracking model contains all the status events that a shipment goes through from the moment it's created to final delivery. This includes timestamps, location data, comments, and both primary and secondary status codes. Evership also includes estimated delivery times and updates for each shipment, giving you visibility into the delivery process.

GETapi.evership.app/v1/tracking-log

Shipment tracking log

This API will allow you to fetch the entire tracking log of a shipment by passing the shipment_id or the waybill_number In the response we will return the entire tracking log for the shipment along with some additional information about the shipment.

Request fields

Name
shipment_id
Type
string
Description
Unique ID for the shipment record that has been created.
Name
waybill_number
Type
string
Description
Waybill number for the shipment record. This is only available if the shipment has been purchased.

Response fields

Name
shipment_id
Type
string
Description
Unique identifier for the shipment.
Name
shipment_title
Type
string
Description
Title or identifier for the shipment.
Name
waybill_number
Type
string
Description
Waybill number associated with the shipment.
Name
latest_status
Type
object
Description
Object containing the latest status of the shipment.
Name
latest_status.status
Type
string
Description
Current status of the shipment (e.g. Delivered).
Name
latest_status.slug
Type
string
Description
Slug identifier for the current status.
Name
latest_status.code
Type
integer
Description
Code representing the current status.
Name
created_time
Type
timestamp
Description
Timestamp of when the shipment was created.
Name
last_updated_time
Type
timestamp
Description
Timestamp of the last update to the shipment.
Name
est_delivery
Type
timestamp
Description
Estimated delivery date and time.
Name
est_delivery_text
Type
string
Description
Formatted string describing the estimated delivery date and time.
Name
tracking_log
Type
array
Description
Array of objects containing tracking log entries for the shipment.
Name
tracking_log[].timestamp
Type
timestamp
Description
Timestamp of the tracking log entry.
Name
tracking_log[].primary_status
Type
object
Description
Object containing the primary status of the tracking log entry.
Name
tracking_log[].primary_status.status
Type
string
Description
Primary status of the shipment at the time of the log entry.
Name
tracking_log[].primary_status.slug
Type
string
Description
Slug identifier for the primary status.
Name
tracking_log[].primary_status.code
Type
integer
Description
Code representing the primary status.
Name
tracking_log[].secondary_status
Type
object
Description
Object containing the secondary status of the tracking log entry (if applicable).
Name
tracking_log[].secondary_status.status
Type
string
Description
Secondary status of the shipment at the time of the log entry.
Name
tracking_log[].secondary_status.slug
Type
string
Description
Slug identifier for the secondary status.
Name
tracking_log[].secondary_status.code
Type
integer
Description
Code representing the secondary status.
Name
tracking_log[].comments
Type
string
Description
Comments or additional information related to the tracking log entry.
Name
tracking_log[].location
Type
string
Description
Location associated with the tracking log entry.

Request

GET https://api.evership.app/v1/tracking-log?shipment_id={shipment_id}&waybill_number={waybill_number}

Response

{
  "shipment_id": "82671",
  "shipment_title": "ABC-123",
  "waybill_number": "CTR791826652",
  "latest_status": {
    "status": "Delivered",
    "slug": "delivered",
    "code": 9
  },
  "created_time": "2025-04-06 22:48:00",
  "last_updated_time": "2025-04-07 14:10:00",
  "est_delivery": "2025-04-12 17:30:00",
  "est_delivery_text": "Monday, 12th April by 5:30 PM",
  "tracking_log": [
    {
      "timestamp": "2025-04-06 22:48:00",
      "primary_status": {
        "status": "Pending",
        "slug": "pending",
        "code": 1
      },
      "comments": "Created by admin admin",
      "location": ""
    },
    {
      "timestamp": "2025-04-06 22:51:00",
      "primary_status": {
        "status": "Collection requested",
        "slug": "collection_requested",
        "code": 2
      },
      "comments": "For collection on Mon, 07 Apr",
      "location": ""
    },
    {
      "timestamp": "2025-04-06 22:51:00",
      "primary_status": {
        "status": "Collection approved",
        "slug": "collection_approved",
        "code": 3
      },
      "comments": "Carrier collecting on Mon, 07 Apr",
      "location": ""
    },
    {
      "timestamp": "2025-04-07 10:37:00",
      "primary_status": {
        "status": "Collected",
        "slug": "collected",
        "code": 5
      },
      "comments": "Your parcel was picked up.",
      "location": "CPT"
    },
    {
      "timestamp": "2025-04-07 12:37:00",
      "primary_status": {
        "status": "In transit",
        "slug": "in_transit",
        "code": 7
      },
      "secondary_status": {
        "status": "Processed at hub",
        "slug": "hub_processed",
        "code": "7A"
      },
      "comments": "The parcel has been left in the South Bay and will be delivered on the next scheduled delivery.",
      "location": "CPT"
    },
    {
      "timestamp": "2025-04-07 12:47:00",
      "primary_status": {
        "status": "In transit",
        "slug": "in_transit",
        "code": 7
      },
      "comments": "Your parcel is currently in transit from our Depot to the courier for delivery.",
      "location": "CPT"
    },
    {
      "timestamp": "2025-04-07 14:03:00",
      "primary_status": {
        "status": "Out for delivery",
        "slug": "out_for_delivery",
        "code": 8
      },
      "secondary_status": {
        "status": "Arrived to deliver",
        "slug": "arrived_deliver",
        "code": "8A"
      },
      "comments": "Onboard - the parcel is onboard the Courier vehicle.",
      "location": "CPT"
    },
    {
      "timestamp": "2025-04-07 14:10:00",
      "primary_status": {
        "status": "Delivered",
        "slug": "delivered",
        "code": 9
      },
      "comments": "Signature Obtained - Your parcel has been delivered and signed for.",
      "location": "CPT"
    }
  ]
}

GETapi.evership.app/v1/tracking-status

Shipment tracking status

This endpoint allows you to create a new group conversation between you and a group of your Protocol contacts.

Request fields

Name
shipment_id
Type
string
Description
Unique ID for the shipment record that has been created.

Response fields

Name
shipment_id
Type
string
Description
Unique identifier for the shipment.
Name
shipment_title
Type
string
Description
Title or identifier for the shipment.
Name
waybill_number
Type
string
Description
Waybill number associated with the shipment.
Name
timestamp
Type
string
Description
Timestamp of a specific event or action related to the shipment.
Name
comments
Type
string
Description
Comments or additional information related to the shipment event.
Name
location
Type
string
Description
Location associated with the shipment event (if applicable).
Name
latest_status
Type
object
Description
Object containing the latest status of the shipment.
Name
latest_status.primary_status
Type
object
Description
Object containing the primary status of the shipment.
Name
latest_status.primary_status.status
Type
string
Description
Current primary status of the shipment (e.g., Delivered, In transit).
Name
latest_status.primary_status.slug
Type
string
Description
Slug identifier for the primary status.
Name
latest_status.primary_status.code
Type
string
Description
Code representing the primary status.
Name
latest_status.secondary_status
Type
object
Description
Object containing the secondary status of the shipment (if applicable).
Name
latest_status.secondary_status.status
Type
string
Description
Secondary status of the shipment (e.g., Processed at hub).
Name
latest_status.secondary_status.slug
Type
string
Description
Slug identifier for the secondary status.
Name
latest_status.secondary_status.code
Type
string
Description
Code representing the secondary status.
Name
created_time
Type
string
Description
Timestamp of when the shipment was created.
Name
last_updated_time
Type
string
Description
Timestamp of the last update to the shipment.
Name
est_delivery
Type
string
Description
Estimated delivery date and time.
Name
est_delivery_text
Type
string
Description
Formatted string describing the estimated delivery date and time.
Name
error
Type
object
Description
Object containing error details for shipments that encountered issues.
Name
error.message
Type
string
Description
Message describing the error encountered for the shipment.

Request

GET https://api.evership.app/v1/tracking-status?shipment_ids={shipment_id_1},{shipment_id_2}

Response

{
  "shipment_id": "43342",
  "shipment_title": "XYZ-789",
  "waybill_number": "CP7123456090",
  "timestamp": "2025-04-26 10:00:00",
  "comments": "Created by Admin Admin",
  "location": "",
  "latest_status": {
    "primary_status": {
      "status": "In transit",
      "slug": "in_transit",
      "code": 7
    },
    "secondary_status": {
      "status": "Processed at hub",
      "slug": "hub_processed",
      "code": 4
    }
  },
  "created_time": "2025-04-26 10:00:00",
  "last_updated_time": "2025-04-27 12:00:00",
  "est_delivery": "2025-04-13 13:00:00",
  "est_delivery_text": "Tuesday, 13th April by 3:00 PM"
},
{
  "shipment_id": "60509",
  "shipment_title": "ABC-123",
  "waybill_number": "CP1234567890",
  "timestamp": "2025-04-26 11:00:00",
  "comments": "Created by John Doe",
  "location": "Warehouse K",
  "latest_status": {
    "primary_status": {
      "status": "Out for delivery",
      "slug": "out_for_delivery",
      "code": 8
    }
  },
  "created_time": "2025-04-26 11:00:00",
  "last_updated_time": "2025-04-26 08:00:00",
  "est_delivery": "2025-04-13 16:00:00",
  "est_delivery_text": "Wednesday, 9th April by 6:00 PM"
},
{
  "shipment_id": "62271",
  "shipment_title": "LMN-654",
  "waybill_number": "CP1421234564",
  "timestamp": "2025-04-26 10:00:00",
  "comments": "Created by admin Jane Smith",
  "location": "Distribution Center B",
  "latest_status": {
    "primary_status": {
      "status": "Delivered",
      "slug": "delivered",
      "code": 9
    }
  },
  "created_time": "2025-04-27 09:30:00",
  "last_updated_time": "2025-04-26 10:00:00",
  "est_delivery": "2025-04-01 14:00:00",
  "est_delivery_text": "Delivered on Tuesday, 01st April at 2:00 PM"
}