Tracking

Endpoints relating to Tracking objects. The Tracking endpoints need special permission to access. Please contact your Flexport Sales representative if you are interested in using these endpoints.

Create a tracking request

For customers enrolled in the visibility service, this endpoint can be used to track a shipment when Flexport is not the freight forwarder.

Request
Request Body schema: application/json
master_bill_of_lading_number
string

Master bill of lading number with SCAC of the shipment you want to track

house_bill_of_lading_number
string

House bill of lading number of the shipment you want to track

scac_code
string

Standard Carrier Alpha Code of the shipment you want to track

container_numbers
required
Array of strings

An array of the container numbers you want to track

cargo_ready_date
string <date>
target_delivery_date
string <date>

Date the client initially set for the shipment to arrive at final destination (not the destination port). Value is provided by the client.

planned_delivery_date
string <date>

Date the shipment was originally planned to arrive at the final destination (not the destination port). Value is generally provided by the freight forwarder or carrier.

forwarder_name
string
object or Array of objects (MetadataCreate)
One of:

Object format.

example_key
Array of strings
Responses
200

The identifiers of the created visibility-only booking

Response Schema: application/json
_object
string
self
string
version
integer
object (TrackingResult)
_object
string

Type of the object

flex_id
string

Flexport's identifier for the shipment to be tracked

booking_fid
string
proposal_fid
string
post/tracking
Request samples
application/json
{
  • "master_bill_of_lading_number": "ONEYHKGA81416701",
  • "house_bill_of_lading_number": "MASA1234567",
  • "scac_code": "ONEYHKGA",
  • "container_numbers": [
    • "SEGU9316914",
    • "FCIU2109480"
    ],
  • "cargo_ready_date": "2020-11-19",
  • "target_delivery_date": "2020-11-30",
  • "planned_delivery_date": "2020-11-30",
  • "forwarder_name": "Forwarder XYZ",
  • "metadata": {
    • "PO": [
      • "1111",
      • "2222"
      ],
    • "SKU": [
      • "3333"
      ]
    }
}
Response samples
application/json

Success

{
  • "_object": "/api/response",
  • "version": 2,
  • "data": {
    • "_object": "/tracking_result",
    • "flex_id": "flx::core:shipment:dbid/123",
    • "booking_fid": "flx::booking:booking:456",
    • "proposal_fid": "flx::booking:order_proposal:789"
    }
}