Changelog
Back to All
added

Location data in tracking events

4 months ago by Chelsea Robb

📘

Executive Summary

This API change introduces a new location_dataobject returned in the tracking_events list when tracking a parcel.

Sendle has introduced a new location_data object to the tracking_events returned by the API's GET /tracking/REF endpoint response.

Example:

"tracking_events": [
  {
    "event_type": "In Transit",
    "scan_time": "2024-08-07T22:39:00Z",
    "description": "Your package has been accepted by our delivery partner.",
    "location": "VALLEY COTTAGE, NY",
    "local_scan_time": "2024-08-07T18:39:00",
    "location_data": {
      "suburb": "VALLEY COTTAGE",
      "state":"NY",
      "postcode":"10989",
      "country":null
    },
    "display_time": "2024-08-07T18:39:00-04:00"
  },
  {
    "event_type": "Out for Delivery",
    "scan_time": "2023-07-14T03:58:20Z",
    "description": "Parcel is onboard the courier vehicle for delivery",
    "local_scan_time": "2023-07-14T13:58:20",
    "location_data": {},
    "display_time": "2023-07-14T13:58:20+10:00"
   }  
]

Location values are not guaranteed to be present, the keys will be returned with a null value when the value is not known. When no granular location data is available to location data will be returned as an empty object.