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#

FedEx#

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