Track

Updated on · 2 min read

Parcels that have been manifested to Parcelpoint can be tracked by your customers using one of the following methods:

  • Link customers to the Parcelpoint tracking page
  • Link customers to the Parcelpoint tracking page using their Tracking Code: parcelpoint.com.au/track/{tracking_code}
  • Create your own tracking page and integrate our tracking system into an existing page using Parcelpoint's Tracking API below

We recommend sending customers to our site, where they can track their parcel in real-time, including a live tracking experience when the driver is on approach (only available for Doorstep Delivery). A unique URL is created for each delivery, using the following format which includes the Tracking Code for the parcel:

https://track.parcelpoint.com.au/{tracking_code}

Parcelpoint provides customer notifications (via email and SMS) which include this tracking link for Returns, Pickup and Doorstep Delivery (varies based on retailer requirements).

Optionally, you can also pull our tracking events into your internal systems, providing visibility for your customer support or operations teams.  You can do this using our Tracking API.

Using the API

This API allows you to receive updates to your ongoing deliveries by sending the current and past events in the journey of the requested delivery.

Request

Staging Endpoint

POST https://trustedapi.staging.parcelpoint.com.au/api/v1/tracking/{tracking_code}

Production Endpoint

POST https://trustedapi.parcelpoint.com.au/api/v1/tracking/{tracking_code}

Depending on the product, the {tracking_code} can be:

  • Tracking Code (Doorstep)
  • Booking Code (Returns)
  • Collection Code (Pickup)

The code above is unique to the parcel and is made up of 7 characters and a numeral (checksum). eg. PG KLH DJ4

Response

{
    "externalId": "PMJQLLP6",
    "data": [
        {
            "createdOn": "2020-10-27T02:18:09.728Z",
            "event": {
                "title": "Get excited!",
                "desc": "Our friends at JoJam have locked us in to deliver your parcel. See you soon!",
                "code": "MAN-DND01"
            }
        },
        {
            "createdOn": "2020-10-27T21:39:35.380Z",
            "event": {
                "title": "We’ve got your parcel",
                "desc": "The Parcelpoint team are carefully getting it ready to start its journey to you!",
                "code": "HUB-DND01"
            }
        },
        {
            "createdOn": "2020-10-27T22:06:39.617Z",
            "event": {
                "title": "Your parcel is in your neighbourhood!",
                "desc": "Our local partner, Terry White Chemmart Chatswood Chase Parcelpoint, is holding onto your parcel while we assign a local runner to deliver your parcel.",
                "code": "COL-DND01"
            }
        },
        {
            "createdOn": "2020-10-28T02:29:27.126Z",
            "event": {
                "title": "Your package has been assigned to a driver",
                "desc": "They'll collect your JoJam parcel. We'll let you know once it's been picked up",
                "code": "ASN-DND01"
            }
        },
        {
            "createdOn": "2020-10-28T03:51:29.848Z",
            "event": {
                "title": "Your driver is on the way",
                "desc": "Your parcel has been picked up by your local driver and is scheduled to arrive between 13:05 and 14:05",
                "code": "PU-DND01"
            }
        },
        {
            "createdOn": "2020-10-28T03:51:42.311Z",
            "event": {
                "title": "Not long now!",
                "desc": "Your parcel from {retailer_name} is just around the corner. Be ready to meet the driver and collect your parcel (ideally on the ground floor if you live in an apartment). <a href='https://track.parcelpoint.com.au/PGKHDGJ3' target='_blank'>Track your driver live</a>.",
                "code": "OFD-DND01"
            }
        },
        {
            "createdOn": "2020-10-28T05:10:48.786Z",
            "event": {
                "title": "It's here!",
                "desc": "The driver is here with your delivery. If you’re not in, we’ll either leave it in a safe place or return it to Terry White Chemmart Chatswood Chase Parcelpoint where you can pick it up later. We’ll let you know soon.",
                "code": "ARR-DND01"
            }
        },
        {
            "createdOn": "2020-10-28T05:11:52.534Z",
            "event": {
                "title": "You’ve got it!",
                "desc": "Your parcel from JoJam has been delivered by your local driver",
                "code": "DEL-DND01"
            }
        }
    ]
}

Parameters

Event Type Description
externalId String ParcelPoint parcelId of the newly booked parcel
CreatedOn String Date the carrier event was created on (UTC timezone)
code String Code of the carrier event. Used for consuming tracking events via internal systems.
title String Title of the carrier event
desc String Short description of what the carrier event was about

Supported tracking descriptions

Below are links to the tracking description for each product. These products also share global tracking descriptions.