Sign in
freight

Get freight shipment by ID

Retrieve a single freight shipment, including its current status, carrier reference numbers, and the documents generated for it.

get/v1/freight/shipments/{freight_shipment_id}

Response

The request was a success.

freight_shipment_idstring

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

freight_provider_account_idstring

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

freight_provider_codestring

The code of the freight provider the shipment was booked through.

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.

bol_numberstring nullable

The Bill of Lading number assigned to the shipment.

pro_numberstring nullable

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

confirmation_numberstring nullable

The carrier's pickup confirmation number. null when the carrier did not return one.

Example response

{
  "freight_shipment_id": "se-28529731",
  "freight_provider_account_id": "se-28529731",
  "freight_provider_code": "UNISHIPPERS",
  "status": "booked",
  "bol_number": "BOL-20260417-4821",
  "pro_number": "072-51293847",
  "confirmation_number": "FXFE-PU-884215",
  "documents": [
    {
      "type": "bill_of_lading",
      "url": "/v1/downloads/10/a1b2c3d4e5f6/bill_of_lading.pdf"
    }
  ]
}

Changes

Changed in 2 of the 7 revisions of this API.42

  • 422fd75e1e3541See the full diff
    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • f3a66d2045651See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog