Sign in

v1

latestOpenAPI 3.0.12026-08-061158187.8 KB
Tracking API

Get events for single parcel

Get a list of tracking events of a single parcel by tracking number.

How to request access

Access to this endpoint is conditional. By default, Ninja Van doesn't grant the permission to use this endpoint to any shipper, even in the sandbox environment. To request access, take these steps:

  1. Review the Integration requirements.
  2. Send an email to developer support.
get/{countryCode}/1.0/orders/tracking-events/{trackingNumber}

Path parameters

countryCode'SG' | 'MY' | 'TH' | 'ID' | 'VN' | 'PH' | 'MM' required

Country code.

trackingNumberstring required

The tracking_number as generated by the Order API.

Headers

Authorizationstring required

Your Bearer token.

Response

Events retrieved successfully.

tracking_numberstring required
is_full_history_availableboolean required

Determine if full events are available for the tracking number provided.

Example response

{
  "tracking_number": "NVSG01NFD000000001",
  "is_full_history_available": true,
  "events": [
    {
      "shipper_id": 100001,
      "tracking_number": "NVSG01NFD000000001",
      "shipper_order_ref_no": "NVQA-NFD",
      "timestamp": "2021-12-15T06:22:48+0000",
      "status": "Pending Pickup",
      "is_parcel_on_rts_leg": false
    },
    {
      "shipper_id": 100001,
      "tracking_number": "NVSG01NFD000000001",
      "shipper_order_ref_no": "NVQA-NFD",
      "timestamp": "2021-12-15T06:23:20+0000",
      "status": "Arrived at Origin Hub",
      "is_parcel_on_rts_leg": false,
      "comments": "SG-BUKIT TIMAH-Zone"
    },
    {
      "shipper_id": 100001,
      "tracking_number": "NVSG01NFD000000001",
      "shipper_order_ref_no": "NVQA-NFD",
      "timestamp": "2021-12-15T06:23:40+0000",
      "status": "Delivered",
      "is_parcel_on_rts_leg": false
    },
    {
      "shipper_id": 100001,
      "tracking_number": "NVSG01NFD000000001",
      "shipper_order_ref_no": "NVQA-NFD",
      "timestamp": "2021-12-15T06:23:40+0000",
      "status": "Delivered, Received by Customer",
      "is_parcel_on_rts_leg": false
    }
  ]
}