Sign in
latestOpenAPI 3.1.0MIT2026-08-221643491.4 MB

d3d8c21cd227

freight

Get freight shipment tracking

<aside class="access" aria-label="Endpoint access"> <table class="access__table"> <thead> <tr> <th class="access__table-header">Products</th> <th class="access__table-header">Plans</th> </tr> </thead> <tbody> <tr> <td class="access__table-cell access__product"> <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/> <div class="access__sub">Formerly ShipEngine</div> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a> </td> </tr> <tr> <td class="access__table-cell"> <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Premium</a> </td> </tr> </tbody> </table> <footer class="access__footer"> <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md"> Learn about products and plans <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/> </a> </footer> </aside>

Retrieve the current tracking status and event history for a booked freight shipment directly from the carrier.

The shipment is tracked by its PRO number when one has been assigned, and by its BOL number otherwise. A shipment that has neither returns a 400 Bad Request with error code freight_tracking_not_available — this is normal immediately after booking, before the carrier assigns a PRO number.

get/v2/freight/shipments/{freight_shipment_id}/tracking

Response

The request was a success.

freight_shipment_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

freight_provider_account_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

freight_provider_namestring

The code of the freight provider used to retrieve the tracking.

carrier_scacstring nullable

The SCAC of the LTL carrier moving the freight.

bol_numberstring nullable

The Bill of Lading number of the shipment.

pro_numberstring nullable

The carrier's PRO number for the shipment, or null until the carrier assigns one.

status'pending' | 'quoted' | 'booked' | 'in_transit' | 'delivered' | 'cancelled' | 'exception'

The lifecycle status of a freight shipment. exception is also returned when the status cannot be determined.

tracking_status'unknown' | 'created' | 'pending_pickup' | 'dispatched' | 'in_route_to_pickup' | 'at_pickup' | 'in_transit' | 'out_for_delivery' | 'at_delivery' | 'delivered' | 'exception' | 'voided' | 'null' nullable

The detailed tracking status reported by the carrier. tracking_status is finer-grained than status: several tracking statuses, such as dispatched and out_for_delivery, all map to the in_transit shipment status.

estimated_delivery_datestring nullable

The carrier's estimated delivery date, in YYYY-MM-DD format.

tracking_urlstring nullable

A carrier page where the shipment can be tracked, when the carrier provides one.

last_event_atstring nullable

When the most recent tracking event occurred.

Example response

{
  "freight_shipment_id": "se-28529731",
  "freight_provider_account_id": "se-28529731",
  "freight_provider_name": "UNISHIPPERS",
  "carrier_scac": "FXFE",
  "bol_number": "BOL-20260417-4821",
  "pro_number": "072-51293847",
  "status": "booked",
  "tracking_status": "in_transit",
  "estimated_delivery_date": "2026-04-22",
  "tracking_url": "https://www.fedex.com/fedextrack/?trknbr=07251293847",
  "last_event_at": "2026-04-20T14:05:00Z",
  "events": [
    {
      "occurred_at": "2026-04-20T14:05:00Z",
      "status": "in_transit",
      "carrier_code": "AF",
      "description": "Departed terminal in Grand Rapids, MI",
      "documents": [
        {
          "type": "PROOF_OF_DELIVERY",
          "filename": "pod_072-51293847.pdf",
          "format": "PDF"
        }
      ]
    }
  ]
}