API - Tracking

Created by KloudShip Support Admin, Modified on Fri, 24 Oct at 7:45 PM by KloudShip Support

GET: Tracking

This API retrieves real-time tracking details of a shipment based on the tracking number. It provides the current status, tracking URL, and event history for the shipment.

Endpoint details:

Method	POST
Production Environment URL	https://api.kloudship.com/api/v1/Tracking/{id}
Test Environment URL	https://api-ppd.kloudship.com:960/api/v1/Tracking/{id}
Content-Type	application/json

Path variable:

Parameter	Type	Required	Description	Example
Id	string	Yes	This id can be Tracking id / Shipment id / Transaction id / TrackingNumber / Tracking Barcode Number	151730780008322

Query parameters:

Parameter	Type	Required	Description	Example
trackingIdType	string	Yes	Specifies the type of tracking ID. Possible values: I`d, ShipmentId, TransactionId, TrackingNumber, TrackingBarcodeNumber`	TrackingNumber
getLatestTracking	boolean	No	If `true`, returns only the latest tracking event. If `false`, returns the full tracking history.	false

Example cURL:

curl --location 'https://api-ppd.kloudship.com:960/api/v1/Tracking/151730780008322?trackingIdType=TrackingNumber&getLatestTracking=false' \
--header 'Authorization: ••••••'

Response fields:

Root Level

Field	Type	Description
`carrier`	`string`	Name of the carrier handling the shipment (e.g., `XpressBees`, `Delhivery`, `All`).
`trackingBarcodeNumber`	`string`	Barcode number associated with the shipment.
`trackingNumber`	`string`	Unique tracking number of the shipment.
`processedStatus`	`string`	Current processed status of the shipment (e.g., `PreTransit`, `InTransit`, `Delivered`).
`processedStatusCode`	`string`	Code representing the processed status.
`status`	`string`	Descriptive message for the shipment’s current status.
`statusCode`	`string`	Short identifier or description of the shipment’s current status.
`trackingUrl`	`string`	URL to the carrier’s official tracking page for this shipment.
`events`	`array`	List of tracking events recorded for the shipment (see Events Object below).
`errors`	`array`	List of errors encountered while fetching tracking information (if any).

Events Object (`events[]`)

Field	Type	Description
`date`	`string (ISO 8601)`	Timestamp of the tracking event (e.g., `"2025-10-16T10:30:56.850Z"`).
`city`	`string`	City where the tracking event occurred.
`state`	`string`	State where the tracking event occurred.
`country`	`string`	Country where the event took place.
`zip`	`string`	Postal / PIN code of the event location.
`referenceId`	`string`	Reference identifier associated with the event (if any).
`processedStatus`	`string`	Status of the shipment at the time of this event (e.g., `PreTransit`, `Delivered`).
`processedStatusCode`	`string`	Code representing the event-level processed status.
`status`	`string`	Descriptive message for this tracking event.
`statusCode`	`string`	Short description or label for this event.
`location`	`string`	Detailed event location (may include hub or facility name).
`referenceType`	`string`	Type of event reference (e.g., `Activity`, `Exception`).
`scope`	`string`	Visibility scope of the event (e.g., `Public`, `Internal`).

Errors Array (`errors[]`)

Field	Type	Description
N/a	`string`	Descriptive message indicating an error or issue encountered during tracking data retrieval.

Example response:

{
    "carrier": "XpressBees",
    "trackingBarcodeNumber": "151730780008322",
    "trackingNumber": "151730780008322",
    "processedStatus": "PreTransit",
    "processedStatusCode": "100",
    "status": "Shipment 151730780008322 created by Guest Admin",
    "statusCode": "Shipment created",
    "trackingUrl": "https://www.xpressbees.com/shipment/tracking?awbNo=151730780008322",
    "events": [
        {
            "date": "2025-09-18T15:27:48.17Z",
            "referenceId": "",
            "processedStatus": "PreTransit",
            "processedStatusCode": "100",
            "status": "Shipment 151730780008322 created by Guest Admin",
            "statusCode": "Shipment created",
            "referenceType": "Activity"
        }
    ],
    "errors": []
}

Not Yet Signed Up?

Get started with KloudShip - This article explains steps like signing up, KYC, and adding balance to your account