QUICKSTART
API Quick Start
Authentication
SignString
OAuth
Overview
Getting Started
Scope List
Versioning
Rate Limit
Body Envelope
Request Errors
Try API Endpoints
CHANGELOG
Changelog
Migration Guide
REFERENCE
API Overview
Trackings
Get trackings
get
Create a tracking
post
Get a tracking by ID
get
Update a tracking by ID
put
Delete a tracking by ID
delete
Retrack an expired tracking by ID
post
Mark tracking as completed by ID
post
Get a tracking (Legacy)
get
Update a tracking (Legacy)
put
Delete a tracking (Legacy)
delete
Retrack an expired tracking (Legacy)
post
Mark tracking as completed (Legacy)
post
Couriers
Get user activated couriers
get
Detect courier
post
Get all couriers
get
Last Checkpoints
Get last checkpoint by tracking ID
get
Get last checkpoint (Legacy)
get
Notifications
Get tracking notification by tracking ID
get
Add a notification by tracking ID
post
Remove a notification by tracking ID
post
Get tracking notification (Legacy)
get
Add a notification (Legacy)
post
Remove a notification (Legacy)
post
Estimated delivery date
Batch prediction for the Estimated Delivery Date
post
MODEL
Tracking
Courier
Checkpoint
Notification
ENUM
Additional Tracking Fields
Delivery Statuses
Delivery Sub-statuses
Slug Groups
Events
Confidence Codes
Webhook
Webhook Overview
Webhook Versioning
Webhook Specifications
Webhook Signature
Webhook OAuth 2.0
Webhook Outgoing IPs
Webhook Changelog
OTHERS
Supported Couriers
CSV Upload & CSV Auto-Fetch
Shipment CSV Export
Order CSV Export
SDK
Android SDK
iOS SDK
Java SDK
Node.js SDK
.NET SDK
Python SDK
Ruby Gem
PHP SDK
Golang SDK
Open Source
phone
email-verifier
Support
Contact Support

Events

A standardized and categorized checkpoint message that represents a physical scan or exception during the logistics and transportation of a package. Each event is associated with a timestamp and tracking number, providing location and status details. Events may include a reason for the exception, and they are linked to specific phases or statuses in the shipment's transportation journey.


The list below explains the different events.

Event codeDescriptionStatus
reroutedThe shipment’s delivery address has been changedIn Transit
dropped_off_at_collection_pointThe shipment has been dropped off at a collection point for the customer to collect itAvailable For Pickup
delivery_attempt_failedThe carrier visited the customer’s address but could not leave the packageFailed Attempt
redelivery_scheduledAnother delivery time has been scheduled following a failed delivery attemptFailed Attempt
delivered_to_a_locationThe shipment has been delivered to the address or specified locationDelivered
delivered_to_neighborThe shipment has been left with a neighborDelivered
held_by_customsThe shipment has been held at customsException
misroutedThe shipment has arrived at an incorrect address or checkpoint. The carrier must reroute the packageException
rejected_by_customerDelivery of the shipment failed as the customer refused to accept the packageException
return_to_sender_requestedThe customer has requested to return the shipment to the senderException
returned_to_senderThe shipment has been returned to the senderException
shipment_lostThe shipment was lostException
canceledThe shipment has been voided or canceled by the sender or carrierException
shipment_damagedThe shipment was damagedException

Description of what result in an exception shipment.


The list below explains the different reasons.

Reason codeDescription
absent_customerThe customer was not at the given address
business_closedThe business was closed at the time of delivery
customer_movedThe customer is no longer at the given address
unclaimedThe shipment was not collected by the customer
prohibited_itemsThe shipment has been found to include prohibited items
no_access_to_delivery_locationThe carrier had no access to the delivery location at the time of delivery
incorrect_missing_addressThe shipment has an incorrect or missing address
failed_to_allocate_driverThe carrier was unable to allocate a driver for the shipment
extreme_weatherThe area is experiencing extreme weather that may affect delivery