Tracking

Get tracking details of a package and the current status.

Return the order shortUid and the checkpoints that indicate the current status and updates of the package.

GET /v1/tracking/{trackingNumber}

Request example

/v1/tracking/EXMPL0001234TRCKNUM

Success response example

{
  "shortUid": "EXMPL0001234",
  "trackingNumber": "EXMPL0001234TRCKNUM",
  "trackingUrl": "https://mydhl.express.dhl/no/en/tracking.html#/results?id=EXMPL0001234TRCKNUM",
  "shipmentMethodUid": "dhl_express_worldwide",
  "shipmentMethodName": "DHL Express Worldwide",
  "carrierUid": "dhl_express",
  "carrierName": "DHL Express",
  "weightInGrams": "460",
  "checkpoints": [
    {
      "status": 6,
      "message": "Delivered",
      "description": "Delivered",
      "location": "LONDON-GBR, United Kingdom",
      "createdAt": "2024-07-29T18:16:06Z",
      "expectedDeliveryDate": "",
      "statusUid": "delivered",
      "signedBy": "aftership"
    },
    {
      "status": 2,
      "message": "Shipment is out with courier for delivery",
      "description": "Out for Delivery",
      "location": "LONDON-GBR, United Kingdom",
      "createdAt": "2024-07-29T08:58:40Z",
      "expectedDeliveryDate": "",
      "statusUid": "out_for_delivery",
      "signedBy": "aftership"
    },
    {
      "status": 1,
      "message": "Arrived at DHL Sort Facility LONDON-HEATHROW-GBR",
      "description": "Arrival scan",
      "location": "LONDON-HEATHROW-GBR, United Kingdom",
      "createdAt": "2024-07-29T00:35:29Z",
      "expectedDeliveryDate": "",
      "statusUid": "in_transit",
      "signedBy": "aftership"
    },
    {
      "status": 1,
      "message": "Scheduled to depart on the next planned movement",
      "description": "Departure Scan",
      "location": "EAST MIDLANDS-GBR, United Kingdom",
      "createdAt": "2024-07-28T12:02:21Z",
      "expectedDeliveryDate": "2024-07-30",
      "statusUid": "in_transit",
      "signedBy": "aftership"
    },
    {
      "status": 1,
      "message": "Customs clearance status updated. Note - The Customs clearance process may start while the shipment is in transit to the destination.",
      "description": "Customs clearance started",
      "location": "EAST MIDLANDS-GBR, United Kingdom",
      "createdAt": "2024-07-26T13:00:23Z",
      "expectedDeliveryDate": "2024-07-30",
      "statusUid": "in_transit",
      "signedBy": "aftership"
    },
    {
      "status": 1,
      "message": "Shipment has departed from a DHL facility ULM-DEU",
      "description": "Departure Scan",
      "location": "ULM-DEU, Germany",
      "createdAt": "2024-07-25T16:41:58Z",
      "expectedDeliveryDate": "2024-07-30",
      "statusUid": "in_transit",
      "signedBy": "aftership"
    },
    {
      "status": 1,
      "message": "Shipment picked up",
      "description": "Acceptance scan",
      "location": "ULM-DEU, Germany",
      "createdAt": "2024-07-25T14:21:55Z",
      "expectedDeliveryDate": "2024-07-30",
      "statusUid": "in_transit",
      "signedBy": "aftership"
    }
  ]
}

Error response example

{
  "trackingNumber": "EXMPL0001234TRCKNUM",
  "code": "TRACKING_DETAILS_NOT_FOUND",
  "message": "Tracking details not found.",
  "details": null
}

Request

Parameter	Type	Description
`trackingNumber` (required)	string	The package tracking number provided by carrier

Successful response

Parameter	Type	Description
`shortUid` (required)	string	A unique short identifier for the response
`trackingNumber` (required)	string	The tracking number of the package
`trackingUrl` (optional)	string	Carrier's tracking URL of the package
`shipmentMethodUid` (optional)	string	Shipment method UID used to deliver the package
`shipmentMethodName` (optional)	string	Shipment method name used to deliver the package
`carrierUid` (optional)	string	Carrier UID used to deliver the package
`carrierName` (optional)	string	Carrier name used to deliver the package
`weightInGrams` (optional)	string	Weight of the package in grams
`checkpoints` (optional)	CheckPoint[]	An array of CheckPoint objects (can be empty)

CheckPoint

Parameter	Type	Description
`status` (required)	number	Status ID number
`statusUid` (required)	string	Status UID (see StatusEnum)
`message` (required)	string	Status message
`description` (optional)	string	Status description
`location` (optional)	string	Current package location (address)
`createdAt` (required)	string	Status created at (RFC3339)
`expectedDeliveryDate` (optional)	string	Expected delivery date (`YYYY-MM-DD`). Example: `2024-01-21`
`signedBy` (required)	string	Which Provider/Service signed it

StatusEnum

Status Value	Description
`registered`	Represents registered status
`in_transit`	Represents in transit status
`out_for_delivery`	Represents out for delivery status
`failed_attempt`	Represents failed attempt status
`shipping_exception`	Represents shipping exception status
`available_for_pickup`	Represents available for pickup status
`delivered`	Represents delivered status
`dispatched`	Represents dispatched status
`returned`	Represents returned status
`not_picked_up`	Represents not picked up status

Error response

Parameter	Type	Description
`trackingNumber`	string	The tracking number of the package
`code`	string	Error code
`message`	string	Error message
`details` (optional)	ResponseErrorDetails	Additional error details

ResponseErrorDetails

Parameter	Type	Description
code	string	Error code.
message	string	Error message
reference (optional)	string	Reference ID.