Documentation

🔑 New Zealand Post Track & Trace

The action is used to get the tracking information from New Zealand Post.

Inputs

NameTypeDescription
Tracking NumberStringNZ Post tracking number
Client IDStringNZ Post Client ID
Client SecretStringNZ Post Client Secret

Outputs

NameTypeDescription
Found Tracking?BooleanWhether the tracking information was found
True / False
StatusStringTracking status:
Ready for Shipment,
Delivered,
In Transit,
Problem with Delivery,
Returning to Sender,
Ready for Pickup
Status DescriptionStringDetailed description of the tracking status
Event DescriptionSgringDetailed description of the tracking event
Shipped DateStringThe date of the shipment.
Format:
YYYY-MM-DDThh:mm:ss
Last Event DateStringThe date of the last tracking event.
Format:
YYYY-MM-DDThh:mm:ss
Tracking InfoObjectAll the tracking data returned from NZ Post
Tracking URLStringNZ Post tracking URL
Activity HistoryListList of all the tracking events.
See the example below

📘

Tracking Status

NZ Post API returns a status code for each tracking event. DG maps this status code to one of the predefined statuses. E.g. 8 - Ready for Shipment.

DG scans all the tracking events to identify whether there is an event with status code that shows the parcel is returning back to the sender.

Statuses mapping

Ready for Shipment: [8, 13, 997, 1013, 5000]

Returning to Sender: [67, 578, 5350]

In Transit: [13, 32, 35, 55, 56, 57, 58, 59, 77, 78, 80, 85, 95, 142, 143, 144, 145, 146, 147, 148, 200, 202, 201, 203, 546, 552, 553, 554, 555, 559, 560, 561, 562, 571, 580, 584, 585, 586, 587, 588, 590, 591, 595, 1014, 1060, 1080, 1081, 1146, 5002, 5007, 5015, 5016, 5017, 5018, 5019, 5020, 5021, 5023, 5024, 5028, 5040, 5041, 5042, 5043, 5044, 5045, 5064, 5186, 5187, 5188, 5192, 5193, 5194, 5195, 5196, 5199, 5200, 5201, 5202, 5203, 5204, 5205, 5206, 5278, 5279, 5280, 5281, 5282, 5283, 5284, 5285, 5286, 5288, 5290, 5291, 5292, 5294, 5295, 5297, 5304, 5305, 5306, 5307, 5308, 5309, 5310, 5311, 5312, 5313, 5314, 5315, 5316, 5317, 5319, 5320, 5321, 5322, 5323, 5324, 5325, 5326, 5327, 5328, 5330, 5331, 5334, 5336, 5340, 5341, 5346, 5347, 5353, 5355, 5356, 5357, 5359, 5360, 5361, 5362, 5363, 5364, 5365, 5366, 5367]

Ready for Pickup: [141, 149, 5046, 5351, 5352]

Problem with Delivery: [42, 50, 51, 52, 53, 54, 60, 61, 62, 63, 542, 544, 547, 548, 549, 550, 556, 558, 564, 589, 596, 597, 1054, 9999, 5299, 5300, 5301, 5318, 5337, 5349, 5369, 5370]

Delivered: [22, 5022, 5207]