StartTracking

This method subscribes to tracking events for one or more identifiers. This endpoint initiate the subscription with the carrier's system.

Request
Request Body schema: application/json

An object containing identifiers to subscribe to tracking events for.

required
Array of objects (TrackingIdentifier)

Array of identifiers (e.g., tracking numbers) to subscribe to tracking events for.

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

Successful subscription response with results for each identifier.

post/StartTracking
Request samples
application/json
{
  • "identifiers": [
    ],
  • "transaction_id": "771323cb-75eb-4e2a-bc11-fda608c6ade8",
  • "authorization": { },
  • "metadata": { },
  • "connection_name": "a_connect_connection_name_string"
}
Response samples
application/json
{
  • "subscription_results": [
    ],
  • "metadata": {
    }
}