/api/shipmentTracking/{awbNumber}

Retrieve detailed tracking information for a shipment using its AWB number.

Responses

🟢200OK

application/json

Successful response with order tracking details.

Body

success

boolean

optional

Indicates if the API call was successful.

Example:

true

status

integer

optional

HTTP status code of the response.

Example:

200

msg

string

optional

Message conveying the outcome of the API call.

Example:

Shipment tracking fetched successfully!!

data

object

optional

Contains detailed shipment tracking information.

shipperReferenceToken

string

optional

Unique reference token for the shipper.

Example:

241109-5f0e-a0f2

awbNumber

string

optional

Air Waybill number for shipment tracking.

Example:

NOEP6312185264

currentDirection

string

optional

Indicates the current direction of the shipment.

Example:

RETURN

courierCode

string

optional

Code of the courier handling the shipment.

Example:

EKART

manifestedTime

integer

optional

Timestamp when the shipment was manifested.

Example:

1731160547000

currentLocation

object

optional

Details of the shipment's current location.

currentStatus

string

optional

Current status of the shipment.

Example:

RETURN_DELIVERY_FAILED

lastEventTime

integer

optional

Timestamp of the last event recorded for the shipment.

Example:

1732208885000

latestShipmentEvent

object

optional

Details of the latest shipment event.

events

array [object {9}]

optional

List of events recorded for the shipment.

pickupAttemptedCount

integer

optional

Number of pickup attempts made.

Example:

deliveryAttemptedCount

integer

optional

Number of delivery attempts made.

Example:

returnDeliveryAttemptedCount

integer

optional

Number of return delivery attempts made.

Example:

exceptionFlag

boolean

optional

Indicates if the shipment is in an exception state.

Example:

false

holdFlag

boolean

optional

Indicates if the shipment is on hold.

Example:

false

missingFlag

boolean

optional

Indicates if the shipment is missing.

Example:

false

cancellationRequested

boolean

optional

Indicates if cancellation of the shipment was requested.

Example:

false

deliveryAttempted

boolean

optional

Indicates if delivery was attempted.

Example:

false

manifested

boolean

optional

Indicates if the shipment was manifested.

Example:

true

pickupAttempted

boolean

optional

Indicates if pickup was attempted.

Example:

false

returnDelivered

boolean

optional

Indicates if the return delivery was completed.

Example:

false

inExceptionState

boolean

optional

Indicates if the shipment is in an exception state.

Example:

false

onHold

boolean

optional

Indicates if the shipment is on hold.

Example:

false

shipmentMissing

boolean

optional

Indicates if the shipment is missing.

Example:

false

returnDeliveryAttempted

boolean

optional

Indicates if a return delivery attempt was made.

Example:

false

rtoInitiated

boolean

optional

Indicates if Return To Origin (RTO) was initiated.

Example:

false

pickupCompleted

boolean

optional

Indicates if the pickup was completed.

Example:

false

delivered

boolean

optional

Indicates if the shipment was delivered.

Example:

false

cancelled

boolean

optional

Indicates if the shipment was cancelled.

Example:

false

Example

{
    "success": true,
    "status": 200,
    "msg": "Shipment tracking fetched successfully!!",
    "data": {
        "shipperReferenceToken": "241109-5f0e-a0f2",
        "awbNumber": "NOEP6312185264",
        "currentDirection": "RETURN",
        "courierCode": "EKART",
        "manifestedTime": 1731160547000,
        "currentLocation": {
            "node": "FKL_Jaipur_BTS"
        },
        "currentStatus": "RETURN_DELIVERY_FAILED",
        "lastEventTime": 1732208885000,
        "latestShipmentEvent": {
            "event": "ReturnDeliveryFailedEvent",
            "subEventCode": "UDL",
            "subEventCodeName": "UNDELIVERED"
        },
        "events": [
            {
                "currentLocation": {
                    "node": "FKL_Jaipur_BTS"
                },
                "currentStatus": "RETURN_DELIVERY_FAILED",
                "previous_status": "RETURN_IN_TRANSIT",
                "timestamp": 1732032485000,
                "eventSource": "COURIER",
                "shipmentEvent": {
                    "event": "ReturnDeliveryFailedEvent",
                    "subEventCode": "UDL",
                    "subEventCodeName": "UNDELIVERED"
                },
                "stateTransitionType": "VALID",
                "otpVerified": false,
                "syntheticEvent": false
            }
        ],
        "pickupAttemptedCount": 1,
        "deliveryAttemptedCount": 0,
        "returnDeliveryAttemptedCount": 5,
        "exceptionFlag": false,
        "holdFlag": false,
        "missingFlag": false,
        "cancellationRequested": false,
        "deliveryAttempted": false,
        "manifested": true,
        "pickupAttempted": false,
        "returnDelivered": false,
        "inExceptionState": false,
        "onHold": false,
        "shipmentMissing": false,
        "returnDeliveryAttempted": false,
        "rtoInitiated": false,
        "pickupCompleted": false,
        "delivered": false,
        "cancelled": false
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

/api/shipmentTracking/{awbNumber}

Request

Request samples

Responses