Tracking

Tracking a package is usually done by providing a tracking number or shipment ID. A shipment ID will return tracking information for all packages associated with that shipment ID. A tracking number tracks the activity of an individual package. Some carriers, like USPS, treat these the same as they don't support multi-package shipments.

Some carriers also allow tracking packages by user provided reference numbers. These can be almost anything but often invoice numbers, PO numbers, or RMA numbers are used. Most carriers require that these packages be created from your carrier account number in order to track them by their reference number.

Request

A rating request will typically have the following parameters:

{
  "carrier": "UPS-REST",
  "action": "Track",
  "params": {
    "key": "YOUR_KEY",
    "tracking_number": "1Z9A556W0301224626"
  }
}

Response

See: Track Response Format for the Track Action

Test Tracking Numbers

Below are some test tracking numbers you can use to test your integration:

UPS

Tracking NumberOptionServiceResponse
1Z12345E0205271688 (Signature Availability)Activity (All)2nd Day AirDelivered
1Z12345E6605272234None (Last)World Wide ExpressDelivered
1Z12345E1305277940None (Last)Next Day Air SaverORIGIN SCAN
1Z12345E6205277936Activity (All)Next Day Air Saver2nd Delivery attempt
1Z12345E020527079None (Last)N/AInvalid Tracking Number
1Z12345E1505270452None (Last)N/ANo Tracking Information Available
990728071Activity (All)UPS Freight LTLIn Transit
3251026119Activity (All)N/ADelivered Origin CFS
9102084383041101186729None (Last)Mail InnovationsN/A
cgish000116630None (Last)None (Last)N/A
1Z648616E192760718ActivityUPS Worldwide Express FreightOrder Processed by UPS
5548789114ActivityUPS Express FreightResponse for UPS Air Freight
ER751105042015062ActivityUPS OceanResponse for UPS Ocean Freight
1ZWX0692YP40636269ActivityUPS SUREPOSTResponse for UPS SUREPOST

FedEx

Tracking NumberResponse
449044304137821Shipment information sent to FedEx
149331877648230Tendered
020207021381215Picked Up
403934084723025Arrived at FedEx location
920241085725456At local FedEx facility
568838414941At destination sort facility
039813852990618Departed FedEx location
231300687629630On FedEx vehicle for delivery
797806677146International shipment release
377101283611590Customer not available or business closed
852426136339213Local Delivery Restriction
797615467620Incorrect Address
957794015041323Unable to Deliver
076288115212522Returned to Sender/Shipper
581190049992International Clearance delay
122816215025810Delivered
843119172384577Hold at Location
070358180009382Shipment Canceled

DHL-PL

  • 11898773100
  • 11898773101
  • 11898773102
  • 11898773103
  • 11898773104

Carrier Specific Considerations

UPS

ship_date_end - ship_date_begin must be within 3 months (90 days) when tracking by reference.

FedEx

On occasion two shipments will share the same tracking number as they are sometimes reused. If this happens a unique_id will be returned in the tracking response without tracking detail. You can use this unique_id value as a tracking_number parameter to request details for this unique shipment.

API Examples

See: API Examples

← RatingShipping Labels →