StartTracking

This method starts tracking for one or more shipment identifiers and creates subscriptions to push tracking updates to configured channels (webhook, SQS, or Kafka).

This method should be implemented if you support push-based tracking notifications where updates are sent to configured endpoints rather than polling for updates.

Request
Request Body schema: application/json

An object containing tracking identifiers and subscription channel configurations.

Array of objects or null (TrackingIdentifier)

List of tracking identifiers to subscribe to

Array of objects or null (SubscriptionChannel)

List of subscription types and protocols

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

Subscription results for each tracking identifier.

post/StartTracking
Request samples
application/json
{
  • "identifiers": [
    ],
  • "subscriptions": [
    ],
  • "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
  • "authorization": {
    },
  • "metadata": {
    },
  • "connection_name": "string"
}
Response samples
application/json
{
  • "subscription_results": [
    ],
  • "metadata": {
    }
}