Express Order Tracking API Documentation (v1.0.9)

1

What Is This API?

Use this API at any time to check where your express shipment is. The response gives you the current status and a full history of every event the order has gone through, from initial booking and rider dispatch to final drop-off.

UTC Timezone Standard Notice

Note: All event times in the tracking response are in UTC (Coordinated Universal Time). For display to end-customers in the UAE, add +4 hours to convert from UTC to Gulf Standard Time (GST).

API Endpoint Details

Property	Value
Request URL (Demo)	`https://demo.jeebly.com/customer/track_express_shipment`
Request URL (Production)	`https://myjeebly.jeebly.com/customer/track_express_shipment`
HTTP Method	POST
Content-Type	`application/json`

2

Authentication Headers

Include the two secret credential headers in every tracking request along with Content-Type: application/json:

Header Name	Description	Required
`X-API-KEY`	Your secret Jeebly API security key.	Yes
`client_key`	Your unique customer account identifier key.	Yes
`Content-Type`	Must be set to `application/json`.	Yes

3

Request Body & Parameters

The request body accepts a JSON object with the single order identifier, order_id:

Field Name	Type	Description	Example	Required
`order_id`	String	The express order ID (`AWB No`) returned when you created the order. Only one order ID can be tracked per request.	`"E240524103039106"`	Yes

4

Sample Requests

Choose your environment below to view complete sample requests matching the official specification:

curl --location 'https://demo.jeebly.com/customer/track_express_shipment' \
--header 'X-API-KEY: YOUR_API_KEY' \
--header 'client_key: YOUR_CLIENT_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "order_id": "E240524103039106"
}'

5

Success Response (200 OK) & Event History

The response returns a Tracking array. Each item in the array is a status event, listed from most recent to oldest (latest status first):

HTTP 200 OK — Delivered Order History

{
  "success": "true",
  "Tracking": [
    {
      "status": "Delivered",
      "cancelreason": null,
      "event_date_time": "2024-03-01T06:39:30Z",
      "rider_id": null,
      "rider_name": "Jeebly Driver",
      "rider_phone": "123456789",
      "lat": "28.631028",
      "lng": "77.382736",
      "pod_image": "https://dashboardlegacy.stage.lyve.global/route_files/133829378/86a6bb4f33d5463.jpg"
    },
    {
      "status": "Picked Up",
      "cancelreason": null,
      "event_date_time": "2024-03-01T06:39:23Z",
      "rider_id": null,
      "rider_name": "Jeebly Driver",
      "rider_phone": "123456789",
      "lat": "28.631028",
      "lng": "77.382736",
      "pod_image": null
    },
    {
      "status": "Assigned",
      "cancelreason": null,
      "event_date_time": "2024-03-01T06:18:14Z",
      "rider_id": "57731",
      "rider_name": "Jeebly Driver",
      "rider_phone": "123456789",
      "lat": "28.753797",
      "lng": "77.496004",
      "pod_image": null
    },
    {
      "status": "Pickup Scheduled",
      "cancelreason": null,
      "event_date_time": "2024-03-01T06:10:42Z",
      "rider_id": "",
      "rider_name": "",
      "rider_phone": "",
      "lat": "",
      "lng": "",
      "pod_image": null
    }
  ]
}

Express Delivery Visual Milestone Timeline

Order Delivered

Delivered

Courier arrived at drop-off location and completed handover.

Jeebly Driver 123456789 View POD Photo

2024-03-01 06:39:30 UTC

Picked Up

Parcel collected from sender. Cancellation window closed.

Lat: 28.631028, Lng: 77.382736

2024-03-01 06:39:23 UTC

Assigned

Courier dispatched and en route to pickup origin.

Rider ID: 57731

2024-03-01 06:18:14 UTC

Pickup Scheduled

Express booking created in Jeebly dispatch engine.

2024-03-01 06:10:42 UTC

Attribute	Type	Description
`status`	String	Express milestone: `"Pickup Scheduled"`, `"Assigned"`, `"Picked Up"`, `"Delivered"`, or `"Cancelled"`.
`cancelreason`	String / Null	Contains cancellation notes if cancelled prior to pickup; otherwise `null`.
`event_date_time`	DateTime (UTC)	Timestamp of the event in strict ISO 8601 UTC format (e.g. `2024-03-01T06:39:30Z`).
`rider_id`	String / Null	Unique driver employee/terminal code (e.g. `"57731"`) once assigned.
`rider_name`	String	Full name of courier driver (e.g. `"Jeebly Driver"`).
`rider_phone`	String	Active mobile contact number of the express rider for pickup/delivery coordination.
`lat / lng`	String	GPS geographical coordinates recorded during checkpoint scan or dispatch trigger.
`pod_image`	String / Null	High-resolution Proof of Delivery (POD) photo URL uploaded upon delivery completion.

6

Error Responses (400 Bad Request)

The tracking endpoint validates authentication credentials and verifies that the provided order_id belongs to your merchant account (official specification):

Case 1 If Client key is wrong:

{
  "success": "false",
  "message": "Invalid Customer Key"
}

Case 2 If the Shipment no is wrong:

{
  "success": "false",
  "message": "Invalid Customer Key or Shipment Number"
}

Case 3 If the API Key is wrong:

{
  "success": "false",
  "message": "Invalid API Token"
}

Case 4 If the format is wrong:

{
  "success": "false",
  "message": "Invalid JSON format"
}

7

Troubleshooting & Resolution Guide

Reference this troubleshooting matrix to resolve tracking lookup failures:

Error Message	What It Means	How to Fix It
`Invalid Customer Key`	Your `client_key` is wrong or missing	Check your `client_key` header
`Invalid Customer Key or Shipment Number`	The order ID does not exist for your account	Make sure you are using the correct order ID from the creation response
`Invalid API Token`	Your `X-API-KEY` is wrong or missing	Check your `X-API-KEY` header
`Invalid JSON format`	The request body has syntax flaws	Check for missing quotes or unclosed brackets around `order_id`

8

Status Milestones & Proof of Delivery (POD)

Express Milestone Progression

Pickup Scheduled: Order registered; waiting for closest rider.
Assigned: Driver assigned; coordinates & phone visible.
Picked Up: Driver at origin; scanned barcode into cargo.
Delivered: Completed delivery; POD photo attached.

Proof of Delivery (POD) Photos

When a shipment reaches Delivered, the pod_image field contains a direct URL to the photo taken by the driver at the doorstep. You can embed this image in customer portals or delivery confirmation emails.

9

Express Delivery Lifecycle Workflow

The complete on-demand express integration workflow consists of three primary endpoints designed for high-speed, direct fulfillment:

Step 1 POST

Create Express Order

Submit pickup and delivery parameters to book the consignment and receive your AWB No.

Creation Guide

Step 2 (Current) POST

Track Express Order

Monitor live courier location, pickup confirmation, and delivery milestones using the order ID.

Open Console

Step 3 POST

Cancel Express Order

Cancel an express shipment before the courier arrives at the pickup origin to release the rider.

Cancel Guide

Express Order Tracking API

Quick Specifications