Skip to main content

Get Tracking History

Suggest Edits

Overview​

The Get Tracking History function provides the list of all shipment events for a certain tracking number. This allows you to track the delivery status of checks sent via carriers.

Resource Access​

Production (api.ahrvo.network)

POST https://api.ahrvo.network/banking/echecks/apiServices/uploadChecks.php?GetTrackingHistory

Staging (gateway.ahrvo.network)

POST https://gateway.ahrvo.network/banking/echecks/apiServices/uploadChecks.php?GetTrackingHistory

Arguments​

AttributeMandatory / Optional
trackingNumberMandatory
inBehalfOptional

Tracking Status Codes​

  • AC - Accepted
  • IT - In Transit
  • DE - Delivered
  • EX - Exception
  • UN - Unknown
  • AT - Delivery Attempt
  • NY - Not Yet in System
  • RETURNED - Returned
  • CANCELLATION - Cancellation

Example Request​

curl -X POST https://gateway.ahrvo.network/banking/echecks/apiServices/uploadChecks.php?GetTrackingHistory \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {jwtToken}" \
  -H "x-api-key: {apiKey}" \
  -d '{
    "trackingNumber": "38750937595975098765665757576",
    "inBehalf": ""
  }'

Example Response​

{
  "errorCode": 0,
  "errorMessage": "",
  "shipmentEvents": [
    {
      "TrackingNumber": "38750937595975098765665757576",
      "TrackingStatusCode": "AC",
      "TrackingStatusDesc": "Accepted",
      "OccurredLocalTime": "2025-02-19T14:30:00",
      "EstimatedDeliveryDate": "2025-02-20",
      "CarrierResponse": {},
      "CarrierErrorCode": "0",
      "CarrierErrorMessage": ""
    },
    {
      "TrackingNumber": "38750937595975098765665757576",
      "TrackingStatusCode": "IT",
      "TrackingStatusDesc": "In Transit",
      "OccurredLocalTime": "2025-02-20T06:25:10",
      "EstimatedDeliveryDate": "2025-02-20",
      "CarrierResponse": {},
      "CarrierErrorCode": "0",
      "CarrierErrorMessage": ""
    },
    {
      "TrackingNumber": "38750937595975098765665757576",
      "TrackingStatusCode": "DE",
      "TrackingStatusDesc": "Delivered",
      "OccurredLocalTime": "2025-02-20T18:10:12",
      "EstimatedDeliveryDate": "2025-02-20",
      "CarrierResponse": {},
      "CarrierErrorCode": "0",
      "CarrierErrorMessage": ""
    }
  ]
}

API Documentation​