Tracking API

Tracking API

The Tracking API provides real-time shipment tracking for consignments, allowing you to retrieve event history and current status.


🔍 Get Tracking Information

Endpoint: GET /v1/track/{ticketNumber}
Description: Returns tracking details and event history for a consignment identified by its ticket number.

Path Parameters

Parameter Type Required Description
ticketNumber string The Freightways ticket or label number (e.g., NZC12345678)

Example Request

 
GET /v1/track/NZC12345678 HTTP/1.1
Host: api.freightways.co.nz
x-api-key: your_api_key_here
Accept: application/json

Response Example (200 OK)

 
{
  "ticketNumber": "NZC12345678",
  "carrier": "NZ Couriers",
  "status": "Delivered",
  "lastUpdated": "2025-10-20T16:45:00Z",
  "events": [
    {
      "timestamp": "2025-10-18T09:45:00Z",
      "location": "Auckland Depot",
      "status": "Collected",
      "description": "Consignment picked up from sender"
    },
    {
      "timestamp": "2025-10-19T07:15:00Z",
      "location": "Hamilton Hub",
      "status": "In Transit"
    },
    {
      "timestamp": "2025-10-20T16:45:00Z",
      "location": "Tauranga",
      "status": "Delivered",
      "description": "Delivered to receiver"
    }
  ] } 

Field Notes

Field Description
ticketNumber Unique tracking number printed on the consignment label
status Current delivery status
events Ordered list of tracking milestones
carrier Freightways carrier (e.g., NZ Couriers, Post Haste)
lastUpdated ISO timestamp of latest status update

Common Status Values

Status Meaning
Collected Consignment collected from sender
In Transit Moving through Freightways network
Out for Delivery Courier has consignment for final delivery
Delivered Delivered to receiver
Exception Delivery delay or issue occurred

Error Responses

Code Example Description
400 Invalid ticket number Incorrect tracking ID format
404 Consignment not found Ticket number does not exist
500 Internal server error Tracking system unavailable

Did this article answer your question?

Can't find the answer to your question?

Suggest an article