Canada Post Track & Trace

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

Inputs

NameTypeDescription
Tracking NumberStringCanada Post tracking number

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
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
Last EventObjectDetailed information about the last tracking event
Tracking URLStringCanada Post tracking URL
Activity HistoryListList of all the tracking events.
See the example below

Sample Response
Activity History

[
    {
        "event-identifier": 4500,
        "event-date": "2021-05-02",
        "event-time": "11:53:00",
        "event-time-zone": "",
        "event-description": "International item is in transit to the delivery office.",
        "signatory-name": "",
        "event-site": "ILTLVA,Israel",
        "event-province": "",
        "event-retail-location-id": "",
        "event-retail-name": ""
    },
    {
        "event-identifier": 4310,
        "event-date": "2021-05-02",
        "event-time": "09:31:07",
        "event-time-zone": "",
        "event-description": "International shipment has arrived in a foreign country",
        "signatory-name": "",
        "event-site": "ILTLVA",
        "event-province": "",
        "event-retail-location-id": "",
        "event-retail-name": ""
    },
    {
        "event-identifier": 4600,
        "event-date": "2021-05-02",
        "event-time": "15:49:00",
        "event-time-zone": "ISRAEL",
        "event-description": "Item has arrived at the delivery office in the destination country",
        "signatory-name": "",
        "event-site": "02650,Israel",
        "event-province": "",
        "event-retail-location-id": "",
        "event-retail-name": ""
    },
    {
        "event-identifier": 4450,
        "event-date": "2021-05-02",
        "event-time": "11:52:00",
        "event-time-zone": "ISRAEL",
        "event-description": "Item has been released by Customs",
        "signatory-name": "",
        "event-site": "Israel",
        "event-province": "",
        "event-retail-location-id": "",
        "event-retail-name": ""
    },
    {
        "event-identifier": 4330,
        "event-date": "2021-05-02",
        "event-time": "08:37:00",
        "event-time-zone": "ISRAEL",
        "event-description": "Item presented to customs",
        "signatory-name": "",
        "event-site": "ILTLVA,Israel",
        "event-province": "",
        "event-retail-location-id": "",
        "event-retail-name": ""
    },
    {
        "event-identifier": 4311,
        "event-date": "2021-05-02",
        "event-time": "08:37:00",
        "event-time-zone": "ISRAEL",
        "event-description": "Item has arrived in foreign country",
        "signatory-name": "",
        "event-site": "ILTLVA,Israel",
        "event-province": "",
        "event-retail-location-id": "",
        "event-retail-name": ""
    },
    {
        "event-identifier": 8901,
        "event-date": "2021-04-22",
        "event-time": "10:48:00",
        "event-time-zone": "EST",
        "event-description": "International item being forwarded to destination country",
        "signatory-name": "",
        "event-site": "MONTREAL",
        "event-province": "QC",
        "event-retail-location-id": "",
        "event-retail-name": ""
    },
    {
        "event-identifier": 100,
        "event-date": "2021-04-21",
        "event-time": "16:41:51",
        "event-time-zone": "EST",
        "event-description": "Item processed",
        "signatory-name": "",
        "event-site": "MONTREAL",
        "event-province": "QC",
        "event-retail-location-id": "",
        "event-retail-name": ""
    },
    {
        "event-identifier": 3000,
        "event-date": "2021-04-21",
        "event-time": "08:02:00",
        "event-time-zone": "EST",
        "event-description": "Electronic information submitted by shipper",
        "signatory-name": "",
        "event-site": "",
        "event-province": "",
        "event-retail-location-id": "",
        "event-retail-name": ""
    }
]

πŸ“˜

Tracking Status

Canada Post API returns a status code for each tracking event. DG maps this status code to one of the predefined statuses. E.g. 20 - 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: [20, 3000, 3002]

Returning to Sender: [157, 167, 168, 169, 181, 182, 183, 184, 1100, 1415, 1416, 1417,
    1418, 1419, 1420, 1481, 1482, 1491, 1492, 2600, 2802, 3001]


In Transit: [100, 102, 104, 105, 106, 107, 113, 114, 115, 116, 122, 123, 124,
    125, 127, 130, 136, 140, 153, 155, 170, 174, 175, 178, 200, 300, 400, 405,
    410, 700, 800, 815, 900, 910, 1000, 1300, 1301, 1302, 1303, 1410, 1411, 1414, 1443,
    1480, 1490, 1703, 2300, 2410, 2411, 2414, 2500, 2501, 2601, 4000, 4100, 4202, 4310, 4311,
    4330, 4400, 4450, 4500, 4550, 4600, 4900, 4950, 5201, 8901, 'CC_ARRIVED_CONS1', 'CC_ARRIVED_CONS2',
    'CC_ARRIVED_CONS3', 'CC_DESPATCH1', 'CC_RELEASED_CUSTOMS1', 'PR01_RECEIVED']

Ready for Pickup: [154, 156, 500, 1407, 1435, 1436, 1437, 1438, 1479, 1488, 1701, 2407]

Problem with Delivery': [117, 118, 120, 121, 150, 152, 159, 160, 161, 162, 163, 171,
    172, 173, 179, 190, 710, 1412, 1450, 1483, 1484, 1487, 1493, 1494, 1495, 2000, 2101,
    2412, 4625, 4650, 4700]

Delivered: [158, 1408, 1409, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429, 1430, 1431,
    1432, 1433, 1434, 1441, 1442, 1496, 1497, 1498, 1499]