API Reference

How to setup the Webhooks in Track123

  1. Add webhook URL from the webhooks settings
  2. Select events to start receiving updates

Sign verification

To ensure that the information source is Track123, it's recommended to verify the sign of the received data(You can also directly parse the POST data without verification). The method of security authentication is as follows:

  1. Parse out the two parameters timestamp and signature in the POST data.
  2. Use your Track123 API key and timestamp (plain text) to generate a signature, and verify it with the signature in the POST data ( signature algorithm: PHP: SHA256, JAVA: HmacSHA256 )

Retry Webhooks

In case of an unsuccessful event (HTTP response code NOT between 200 and 299), Track123 attempts to deliver your webhooks up to 7 times.

Times of attemptsTimes of retriesRetry interval (sec)
100
21600
321800
433600
5414400
6543200
76129600

Webhook specifications

{
    "data": {
        "createTime": "2021-09-24 14:57:51",
        "deliveredDays": 4,
        "deliveredTime": "2021-08-12 10:32:41",
        "id": 229255084490768384,
        "lastTrackingTime": "2021-08-12 10:32:41",
        "localLogisticsInfo": {
            "courierCode": "4px",
            "courierHomePage": "http://express.4px.com/",
            "courierNameCN": "递四方",
            "courierNameEN": "4PX",
            "trackingDetails": [
                {
                    "address": "Mableton, GA",
                    "timezone": "+08:00",
                    "eventDetail": "Delivered",
                    "eventTime": "2021-08-12 10:32:41",
                    "eventTimeZeroUTC": "2024-12-05T10:19:29Z",
                    "transitSubStatus": "DELIVERED_01"
                },
                {
                    "address": "AUSTELL, GA",
                    "timezone": "+08:00",
                    "eventDetail": "On fedex vehicle for delivery",
                    "eventTime": "2021-08-12 03:09:00",
                    "eventTimeZeroUTC": "2024-12-05T10:19:29Z",
                    "transitSubStatus": "WAITING_DELIVERY_01"
                },
                {
                    "address": "AUSTELL, GA",
                    "timezone": "+08:00",
                    "eventDetail": "Arrived at fedex location",
                    "eventTime": "2021-08-12 03:04:00",
                    "eventTimeZeroUTC": "2024-12-05T10:19:29Z",
                    "transitSubStatus": "IN_TRANSIT_01"
                },
                {
                    "address": "AUSTELL, GA",
                    "timezone": "+08:00",
                    "eventDetail": "In transit",
                    "eventTime": "2021-08-11 17:26:46",
                    "eventTimeZeroUTC": "2024-12-05T10:19:29Z",
                    "transitSubStatus": "IN_TRANSIT_01"
                },
                {
                    "address": "KENNESAW, GA",
                    "eventDetail": "Departed fedex location",
                    "eventTime": "2021-08-11 04:30:39",
                    "eventTimeZeroUTC": "2024-12-05T10:19:29Z",
                    "transitSubStatus": "IN_TRANSIT_01"
                },
                {
                    "address": "EDISON, NJ",
                    "timezone": "+08:00",
                    "eventDetail": "Departed fedex location",
                    "eventTime": "2021-08-09 10:27:51",
                    "eventTimeZeroUTC": "2024-12-05T10:19:29Z",
                    "transitSubStatus": "IN_TRANSIT_01"
                },
                {
                    "address": "USNYCA",
                    "timezone": "+08:00",
                    "eventDetail": "Packing the operating point",
                    "eventTime": "2021-08-07 00:40:24",
                    "eventTimeZeroUTC": "2024-12-05T10:19:29Z",
                    "transitSubStatus": "INFO_RECEIVED_01"
                },
                {
                    "address": "USNYCA",
                    "timezone": "+08:00",
                    "eventDetail": "Picking the operating point",
                    "eventTime": "2021-08-07 00:13:57",
                    "eventTimeZeroUTC": "2024-12-05T10:19:29Z",
                    "transitSubStatus": "INFO_RECEIVED_01"
                },
                {
                    "address": "",
                    "timezone": "+08:00",
                    "eventDetail": "Shipment information sent to fedex",
                    "eventTime": "2021-08-06 17:34:00",
                    "eventTimeZeroUTC": "2024-12-05T10:19:29Z",
                    "transitSubStatus": "INFO_RECEIVED_01"
                }
            ]
        },
        "orderTime": "2021-08-06 17:34:00",
        "receiptDays": 39,
        "receiptTime": "2021-08-09 10:27:51",
        "shipFrom": "US",
        "shipTime": "2021-07-01 12:30:31",
        "shipTo": "US",
        "trackNo": "282295361468",
        "transitStatus": "DELIVERED",
        "transitSubStatus": "DELIVERED_01"
    },
    "verify": {
        "signature": "e53cf138931ad85d20955dfc6a0355e777f915a4f511e147c9bd2c6942273151",
        "timestamp": "1632466678868"
    }
}