Track

This method returns tracking information for a shipment, including each of the tracking events that have occurred for the shipment.

Most carrier applications should implement this method, unless you don't support tracking shipments.

Request
Request Body schema: application/json

An object containing information about the label to track.

Array of objects or null (TrackingIdentifier)

This array represents the custom identifiers for a carrier.

Array of objects or null (TrackingAttribute)

Extra attributes of a shipment needed in tracking

transaction_id
required
string <uuid>

The transaction ID uniquely represents this request. If the request is retried then this transaction ID will be the same. You should only perform the requested action once per given transaction ID.

object (Authorization)
object or null
connection_name
string or null

The name of the connection to use, if this app has connection names defined

Responses
200

An object with tracking information for the specified shipment.

post/Track
Request samples
application/json
{
  • "tracking_number": "12345678901234567890",
  • "is_return": false,
  • "identifiers": [
    ],
  • "attributes": [
    ],
  • "transaction_id": "00000000-0000-0000-0000-000000000000",
  • "metadata": {
    }
}
Response samples
application/json
{
  • "tracking_info": {
    }
}