Track

The Track resource allows clients to retrieve tracking events for shipments by their tracking number. You may only track one shipment per request. This endpoint is rate limited.

Scope: none

Actions

GET /track/{tracking_number} Get events for a tracking number

Properties

carrier

{"carrier": "DHLeC"}

String - The last mile carrier code for the shipment.
created

{"created": "2023-06-30T17:14:10+00:00"}

String - The date and time the shipment was created.
destination 

{
    "destination": {
        "city": "BROOKLYN",
        "province": "NY",
        "country": "US",
        "port": "JFK"
    }
}

Object - The shipment destination.

  • city
  • province
  • country
  • port
entry_point

{"entry_point": "HKG101"}

String - The shipment origin code.
events 

{
    "events": [
        {
            "time": "2023-07-01 01:14:10",
            "city": "Shenzhen",
            "province": "GDG",
            "postal_code": "300000",
            "country": "CN",
            "code": 100,
            "carrier": "BoxC",
            "description": "SHIPMENT LABEL CREATED"
        }
    ]
}

Array - A list of tracking events sorted in chronological descending order.
order_number

{"order_number": "ABC1234-583"}

String|null - The shipment order number.
service

{"service": "BoxC Parcel"}

String - The shipment service name.
shipment_id

{"shipment_id": 10002312}

Int - The shipment ID.
status

{"status": "En Route"}

String - The tracking status of the shipment.
tracking_number

{"tracking_number": "9261290198179000000172"}

String - The shipment tracking number.
GET
/track/{tracking_number}
Get events for a tracking number
request
GET /track/9261290198179000000172 

        

        

        

            
response

            
HTTP/1.1 200 OK

            
{
    "track": {
        "created": "2023-06-30T17:14:10+00:00",
        "carrier": "DHLeC",
        "destination": {
            "city": "BROOKLYN",
            "province": "NY",
            "country": "US",
            "port": "JFK"
        },
        "entry_point": "HKG101",
        "order_number": null,
        "service": "BoxC Parcel",
        "shipment_id": 1000406,
        "status": "En Route",
        "tracking_number": "9261290198179000000172",
        "events": [
            {
                "time": "2023-07-01 01:14:10",
                "city": "Shenzhen",
                "province": "GDG",
                "postal_code": "300000",
                "country": "CN",
                "code": 100,
                "carrier": "BoxC",
                "description": "SHIPMENT LABEL CREATED"
            }
        ]
    }
}