Get tracking status for a tracked shipment

{
  "payload": {
    "trackingId": "string",
    "alternateLegTrackingId": "string",
    "eventHistory": [
      {
        "eventCode": "string",
        "eventTime": "2024-01-15T09:30:00Z",
        "location": {
          "city": "string",
          "stateOrRegion": "string",
          "countryCode": "string",
          "postalCode": "string"
        },
        "description": "string"
      }
    ],
    "promisedDeliveryDate": "2024-01-15T09:30:00Z",
    "summary": {
      "status": "PRE_TRANSIT",
      "statusUpdatedTime": "2024-01-15T09:30:00Z"
    },
    "proofOfDelivery": {
      "deliveredTime": "2024-01-15T09:30:00Z",
      "recipientName": "string",
      "signatureImage": "string"
    }
  }
}

Returns the current tracking status, event history, and any proof-of-delivery details for the given trackingId/carrierId pair.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

trackingIdstringRequired

Tracking identifier returned by purchaseShipment.

carrierIdstringRequired

Carrier identifier whose tracking is being requested.

Response

Tracking details returned successfully

payloadobjectOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error