Flexport
4.0
4.0/5

[┐∵]-

Shipment Legs API

Flexport shipment legs API for fetching a list of shipment route legs (or an individual leg) with details
The shipment legs API by Flexport maintains data for the purpose of fetching a list of shipment route legs (or an individual leg) with details. With the system clients may filter determined by page, per, f. Shipment. Id, f. Transportation_mode, f. Include_deleted and id to obtain the response output clients would like. The API covers global data. Certain examples of the type of business that uses it are freight and logistics companies, importers, exporters and international traders, typically the clients can be small business, medium business and enterprises within the freight, maritime, logistics, import, export and trade industry. Some possible use cases with the shipment legs API are for example; displaying shipment leg details, eCommerce optimization, simplifying supply chain tasks, creating/optimizing maritime operations and more. It is also possible that people have uncommon use cases which weren’t thought of previously. It is interesting to read about them.

Shipment Legs API endpoints

GET
GET
/shipment_legs
/shipment_legs/{id}
GET /shipment_legs
GET /shipment_legs/{id}
Communicate to the shipments route legs API endpoint; /shipment_legs by sending a GET request for data to the endpoint with the appropriate parameters and receive the output like in the example data. The endpoint is for fetching a list of shipment route legs (or an individual leg) with details. In order to make the request, place the endpoint into the URL field. To get the response desired, use the objects and parameters as described by the object table. Working with your API key parameter and connecting to it with your personal key, you will start receiving data working with any of the leading coding languages.

Filtering methods for shipment legs data

Here you will see the applicable filtering parameters for the shipment legs data.
Filters
page id
per
f.shipment.id
f.transportation_mode
f.include_deleted

Data object attributes

Access the required data from the API using the different parameters applicable and the table to understand the objects.
Objects Description
shipment
_object
ref_type
link
id
estimated_arrival_date
actual_arrival_date
estimated_departure_date
actual_departure_date
deleted_at
additional_dates
cargo_ready_date
delivery_appointment_requested_at_date
delivery_appointment_requested_date
delivery_appointment_scheduled_at_date
delivery_appointment_scheduled_date
loaded_on_truck_date
delivery_completed
origin
address
etc etc

Shipment legs API output response

Opt-in for the API to call the full data responsebut you can already see a preview of the response here.
				
					{
  "_object": "/api/response",
  "self": "https://api.flexport.com/shipment_legs",
  "version": 2,
  "data": {
    "_object": "/api/collections/paginated",
    "prev": "https://api.flexport.com/shipment_legs?page=1",
    "next": "https://api.flexport.com/shipment_legs?page=3",
    "data": [
      {
        "_object": "/shipment_leg",
        "id": 948211,
        "shipment": {
          "_object": "/api/refs/object",
          "ref_type": "/shipment",
          "link": "https://api.flexport.com/shipments/123",
          "id": 123
        },
        "estimated_arrival_date": "2019-02-06T19:28:25.000+00:00",
        "actual_arrival_date": "2019-02-06T19:28:25.000+00:00",
        "estimated_departure_date": "2019-02-06T19:28:25.000+00:00",
        "actual_departure_date": "2019-02-06T19:28:25.000+00:00",
        "deleted_at": null,
        "additional_dates": {
          "cargo_ready_date": "2019-02-06",
          "delivery_appointment_requested_at_date": "2019-07-09T12:00:00.000+08:00",
          "delivery_appointment_requested_date": "2019-07-14T12:00:00.000+08:00",
          "delivery_appointment_scheduled_at_date": "2019-07-11T12:00:00.000+08:00",
          "delivery_appointment_scheduled_date": "2019-07-14T12:00:00.000+08:00",
          "loaded_on_truck_date": "2019-07-13T12:00:00.000+08:00",
          "delivery_completed": "2019-07-14T12:00:00.000+08:00"
        },
        "origin": {
          "_object": "/shipment_node",
          "tags": [
            "port_of_loading"
          ],
          "place": {
            "_object": "/place",
            "name": "ORD - Chicago - IL",
            "address": {
              "_object": "/address",
              "street_address": "10000 West O'Hare Ave",
              "street_address2": "PO Box 66142",
              "city": "Chicago",
              "state": "IL",
              "country": "United States of America",
              "country_code": "US",
              "zip": "60666",
              "unlocode": "US AL2",
              "timezone": "America/Chicago",
              "ref": ""
            },
            "details": [
              {
                "_object": "/air/port",
                "port_code": "3901",
                "country_code": "US",
                "iata_code": "ORD",
                "icao_code": "KORD"
              },
              {
                "_object": "/trucking/port",
                "port_code": "3901"
              }
            ]
          },
          "terminal": {
            "_object": "/shipment_node/terminal",
            "name": "Terminal 3",
            "address": {
              "_object": "/address",
              "street_address": "1645 Settlers Lane",
              "street_address2": null,
              "city": "Albany",
              "state": "MN",
              "country": "United States of America",
              "country_code": "US",
              "zip": "56307",
              "unlocode": "US AL2",
              "timezone": "America/Chicago",
              "ref": "address_ref_1"
            }
          }
        },
        "destination": {
          "_object": "/shipment_node",
          "tags": [
            "port_of_loading"
          ],
          "place": {
            "_object": "/place",
            "name": "ORD - Chicago - IL",
            "address": {
              "_object": "/address",
              "street_address": "10000 West O'Hare Ave",
              "street_address2": "PO Box 66142",
              "city": "Chicago",
              "state": "IL",
              "country": "United States of America",
              "country_code": "US",
              "zip": "60666",
              "unlocode": "US AL2",
              "timezone": "America/Chicago",
              "ref": "address_ref_1"
            },
            "details": [
              {
                "_object": "/air/port",
                "port_code": "3901",
                "country_code": "US",
                "iata_code": "ORD",
                "icao_code": "KORD"
              },
              {
                "_object": "/trucking/port",
                "port_code": "3901"
              }
            ]
          },
          "terminal": null
        },
        "transportation_mode": "ocean",
        "carrier_name": "Liberty Carrier",
        "air_leg": null,
        "trucking_leg": null,
        "rail_leg": null,
        "ocean_leg": {
          "_object": "/ocean/shipment_leg",
          "scac_code": "XJAE",
          "vessel_name": "Lenox",
          "vessel_imo": "IMO9074729",
          "voyage_number": "059E",
          "container_legs": {
            "_object": "/api/refs/collection",
            "ref_type": "/ocean/shipment_container_leg",
            "link": "https://api.flexport.com/ocean/shipment_container_legs?f.shipment_container.id=123"
          }
        }
      }
    ]
  }
}
				
			

SDK

Use whichever of the filter attributes to select the shipment legs data that is required. The API system delivers output in JSON file format and for programming languages such as; JAVA, C#, PHP, Python, Javascript, Scala, Swift, NodeJS, R, Ruby, VueJS, Strest, Rust, Go, JQuery and Angular there are SDKs available, now just ask for it and it will be sent by email shortly.

Shipment Legs API pricing

Samples and trials access is freely available if requested, just make contact and ask for it. Customers can access the shipments route legs data and check if it is exactly that which customers are searching for. After trying it, people can determine if they are ready to continue with the paid version.

Price and cost of API

The API developed by Flexport is available with secure payment and immediate access.
Prices
Price upon request

Trial

trial is available

Alternative options

Flexport

Shipment Purchase Order List API
4.0
4.0/5
Shipment data via shipment purchase order list API output has required details to make sure you can build excellent online products. Contact the Shipment Purchase Order List API provider to directly get detailed data for fetching a list of purchase order line items or a single line item and similar objectives today.

Datalastic

Historical Vessel Tracker API
5.0
5.0/5
Historical Vessel Tracker API by Datalastic is here to offer quality and fundemental elements necessary to have in tracking past vessel movements and routes, freight route analysis, creating/optimizing maritime operations and more related projects. Historical Vessel Tracker API offers data solutions to develop projects for getting historical vessel movement, activities speed, course, heading, destination and more objectives.

Tradelens

Actionable Doc Flow API
4.3
4.3/5
Actionable Doc Flow API proposes accurate automating transportation documents, tracking containers, digitalizing bills of lading, lowering carrying costs and more data for advancing iOS and Android apps, online products, tools, programs, market inquiries and more. This actionable doc flow API includes a huge amount of Transportation data inclusive of all the details you want.

Datalastic

Live Ship Tracking API
4.5
4.5/5
The live ship tracking API is the top data tool to straightaway receive Maritime data to your project. Live Ship Tracking API proposes precise tracking vessel movements and routes, freight route analysis, creating/optimizing maritime operations and more data for building mobile apps, online services, tools, programs, market analysis and more.

Tradelens

Actionable Transportation Doc Flow Queries API
4.0
4.0/5
Actionable Transportation Doc Flow Queries API by Tradelens is here to offer quality and necessary elements required for automating transportation documents, tracking containers, digitalizing bills of lading, lowering carrying costs and more related projects. Actionable Transportation Doc Flow Queries API grants external data solutions to create projects for automating transportation documents and querying all next actions for a given FlowInstanceId use cases.

Datalastic

Location Maritime Traffic Tracking API
4.7
4.7/5
Location Maritime Traffic Tracking API offers data solutions to build data-oriented products for scanning an area in the sea or ocean to see all the ships in your selected area purposes. Maritime data via location maritime traffic tracking API provides all fitting information to make sure you can develop on point data products.

Sign up for Flexport shipment legs API

Get Data Access

~[ ∵ ]~

Sign-up Succesful

Wait for the Data