Flexport
4.6
4.6/5

[┐∵]-

Shipments API

Flexport shipments API for fetching a list of shipments (or an individual shipment) with details
The shipments API of Flexport has data for fetching a list of shipments (or an individual shipment) with details. Certain projects for the shipment details API are for example; displaying shipment details, eCommerce optimization, simplifying supply chain tasks, creating/optimizing maritime operations and more. It is ofcourse possible that people have uncommon use cases which aren’t thought of previously. It is fantastic to read about these. This database has global data coverage available. Certain examples of the possible filters are page, per, sort, direction, f. Transportation_mode, f. Status and more, use these to determine the data output. The data is used by small business, medium business and enterprises, they use it in the freight, maritime, logistics, import, export and trade sector. Certain ideas of the type of company that uses it are freight and logistics companies, importers, exporters and international traders.

Shipments API endpoints

GET
GET
/shipments
/shipments/{id}
GET /shipments
GET /shipments/{id}
To use this system for fetching a list of shipments (or an individual shipment) with details, clients should connect with the API endpoint; /shipments to receive a similar response as in the response of the example. Input the endpoint into the URL to make the data request. The API documentation works with all major coding languages, simply add your API key parameter to the API endpoint URL and set it up to your private key to begin receiving the requested data. In order to get the output required, make use of the parameters and objects as described in the object and description table.

Data filters

Below you may see the available filtering methods with the shipments API.
Filters
page f.status f.updated_at.gt
per f.statuses.any f.updated_at.lt
sort f.container_number f.archived_at.gt
direction f.purchase_order f.archived_at.lt
f.transportation_mode f.sku f.master_bill_number

Shipments API data attributes

Make use of the object table to interpret the objects with their description and make a call by using the different parameters available.
Objects Description
booking
_object
ref_type
link
id
transportation_mode
freight_type
incoterm
calculated_weight
calculated_volume
pieces
it_number
created_date
status
priority
updated_at
estimated_departure_date
actual_departure_date
estimated_arrival_date
actual_arrival_date
etc etc

Shipments API response output

On this page customers can find the response preview. Opt-in for the complete response output because this being limited to be able to make it readable.
				
					{
  "_object": "/api/response",
  "self": "https://api.flexport.com/shipments?page=1&per=20&sort=id&direction=desc",
  "version": 2,
  "data": {
    "_object": "/api/collections/paginated",
    "prev": null,
    "next": null,
    "data": [
      {
        "metadata": {},
        "_object": "/shipments",
        "id": 2983,
        "name": "ABC Shipment",
        "booking": {
          "_object": "api/refs/object",
          "ref_type": "/booking",
          "link": "https://api.flexport.com/bookings/12345",
          "id": 12345
        },
        "transportation_mode": "ocean",
        "freight_type": "door_to_door",
        "incoterm": "FOB",
        "calculated_weight": {
          "_object": "/quantity/weight",
          "value": 2300.4,
          "unit": "kg"
        },
        "calculated_volume": {
          "_object": "/quantity/volume",
          "value": 472.62,
          "unit": "cbm"
        },
        "pieces": 8372,
        "it_number": "V12345678",
        "created_date": "2019-02-06T19:28:25.741Z",
        "status": "in_transit_to_arrival_port",
        "priority": "high",
        "updated_at": "2019-02-06T19:28:25.119Z",
        "estimated_departure_date": "2019-02-06T19:28:25+00:00",
        "actual_departure_date": "2019-02-06T19:28:25+00:00",
        "estimated_arrival_date": "2019-02-06T19:28:25+00:00",
        "actual_arrival_date": "2019-02-06T19:28:25+00:00",
        "estimated_picked_up_in_full_date": "2019-02-06T19:28:25+00:00",
        "actual_picked_up_in_full_date": "2019-02-06T19:28:25+00:00",
        "estimated_delivered_in_full_date": "2019-02-06T19:28:25+00:00",
        "actual_delivered_in_full_date": "2019-02-06T19:28:25+00:00",
        "cargo_ready_date": "2019-02-06",
        "wants_export_customs_service": true,
        "wants_import_customs_service": true,
        "air_shipment": null,
        "wants_freight_management_bco": true,
        "wants_flexport_freight": true,
        "wants_commercial_invoice_transcription": true,
        "wants_flexport_insurance": true,
        "wants_pickup_service": false,
        "wants_trade_declaration_service": false,
        "visibility_only": false,
        "wants_delivery_service": false,
        "belongs_to_a_buyers_consol": false,
        "child_shipments": null,
        "parent_shipment": null,
        "ocean_shipment": {
          "_object": "/ocean/shipment",
          "is_lcl": false,
          "house_bill_number": "TUWSANR18658",
          "master_bill_number": "NEWO697216024",
          "carrier_booking_number": "697216024",
          "confirmed_space_released_at": "2021-06-08T06:18:46.299Z",
          "containers": {
            "_object": "/api/refs/collection",
            "ref_type": "/ocean/shipment_container",
            "link": "https://api.flexport.com/ocean/shipment_containers?f.shipment.id=123"
          }
        },
        "dangerous_goods": {
          "review_status": "complete",
          "classifications": []
        },
        "shippers": [
          {
            "_object": "/company_entity",
            "id": 9281,
            "name": "Zoomit",
            "mailing_address": {
              "_object": "/address",
              "street_address": "1641 Settlers Lane",
              "street_address2": "STE 2918",
              "city": "Albany",
              "state": "MN",
              "country": "United States of America",
              "country_code": "US",
              "zip": "56307",
              "unlocode": "US AL2",
              "timezone": "America/Chicago",
              "ref": "address_ref_1"
            },
            "ref": "zoomit_ref",
            "vat_numbers": [
              {
                "_object": "company_entity/vat_number",
                "country_code": "US",
                "number": "US 123746396"
              }
            ]
          }
        ],
        "consignees": [
          {
            "_object": "/company_entity",
            "id": 9281,
            "name": "Zoomit",
            "mailing_address": {
              "_object": "/address",
              "street_address": "1641 Settlers Lane",
              "street_address2": "STE 2918",
              "city": "Albany",
              "state": "MN",
              "country": "United States of America",
              "country_code": "US",
              "zip": "56307",
              "unlocode": "US AL2",
              "timezone": "America/Chicago",
              "ref": "address_ref_1"
            },
            "ref": "zoomit_ref",
            "vat_numbers": [
              {
                "_object": "company_entity/vat_number",
                "country_code": "US",
                "number": "US 123746396"
              }
            ]
          }
        ],
        "buyers": [
          {
            "_object": "/company_entity",
            "id": 9281,
            "name": "Zoomit",
            "mailing_address": {
              "_object": "/address",
              "street_address": "1641 Settlers Lane",
              "street_address2": "STE 2918",
              "city": "Albany",
              "state": "MN",
              "country": "United States of America",
              "country_code": "US",
              "zip": "56307",
              "unlocode": "US AL2",
              "timezone": "America/Chicago",
              "ref": "address_ref_1"
            },
            "ref": "zoomit_ref",
            "vat_numbers": [
              {
                "_object": "company_entity/vat_number",
                "country_code": "US",
                "number": "US 123746396"
              }
            ]
          }
        ],
        "sellers": [
          {
            "_object": "/company_entity",
            "id": 9281,
            "name": "Zoomit",
            "mailing_address": {
              "_object": "/address",
              "street_address": "1641 Settlers Lane",
              "street_address2": "STE 2918",
              "city": "Albany",
              "state": "MN",
              "country": "United States of America",
              "country_code": "US",
              "zip": "56307",
              "unlocode": "US AL2",
              "timezone": "America/Chicago",
              "ref": "address_ref_1"
            },
            "ref": "zoomit_ref",
            "vat_numbers": [
              {
                "_object": "company_entity/vat_number",
                "country_code": "US",
                "number": "US 123746396"
              }
            ]
          }
        ],
        "importers_of_record": [
          {
            "_object": "/company_entity",
            "id": 9281,
            "name": "Zoomit",
            "mailing_address": {
              "_object": "/address",
              "street_address": "1641 Settlers Lane",
              "street_address2": "STE 2918",
              "city": "Albany",
              "state": "MN",
              "country": "United States of America",
              "country_code": "US",
              "zip": "56307",
              "unlocode": "US AL2",
              "timezone": "America/Chicago",
              "ref": "address_ref_1"
            },
            "ref": "zoomit_ref",
            "vat_numbers": [
              {
                "_object": "company_entity/vat_number",
                "country_code": "US",
                "number": "US 123746396"
              }
            ]
          }
        ],
        "items": [
          {
            "_object": "/shipment_item",
            "id": 29820,
            "total_units": 523,
            "total_weight": {
              "_object": "/quantity/weight",
              "value": 2300.4,
              "unit": "kg"
            },
            "total_volume": {
              "_object": "/quantity/volume",
              "value": 472.62,
              "unit": "cbm"
            },
            "purchase_order_number": "PO002811",
            "product": {
              "_object": "/product",
              "id": 84291,
              "name": "AC Adapter 12V",
              "sku": "WDVCDFD-RM00472"
            }
          }
        ],
        "legs": {
          "_object": "/api/refs/collection",
          "ref_type": "/shipment_leg",
          "link": "https://api.flexport.com/shipment_legs?f.shipment.id=123"
        },
        "customs_entries": {
          "_object": "/api/refs/collection",
          "ref_type": "/customs_entry",
          "link": "https://api.flexport.com/customs_entries?f.shipment.id=2983"
        },
        "commercial_invoices": {
          "_object": "/api/refs/collection",
          "ref_type": "/commercial_invoice",
          "link": "https://api.flexport.com/commercial_invoices?f.shipment.id=2983"
        },
        "documents": {
          "_object": "/api/refs/collection",
          "ref_type": "/document",
          "link": "https://api.flexport.com/documents?f.shipment.id=2983"
        },
        "departure_date": "2019-02-06T19:28:25+00:00",
        "arrival_date": "2019-02-06T19:28:25+00:00",
        "picked_up_in_full_date": "2019-02-06T19:28:25+00:00",
        "delivered_in_full_date": "2019-02-06T19:28:25+00:00"
      }
    ]
  }
}
				
			

Software development kits

It is a JSON system and in case customers would like SDKs, they are available for JAVA, C#, PHP, Python, Javascript, Scala, Swift, NodeJS, R, Ruby, VueJS, Strest, Rust, Go, JQuery and Angular. Just request it and they are sent. Begin using the filter attributes and use the output with the SDKs and develop the project.

Shipments API pricing

Before determining to purchase API access you are able to request for samples and trials of the shipment details data. Email and ask for the trial access and you will be able to experiment with the API. It won’t be without limits but it will be sufficient to check the system.

Cost and price of API

Flexport data access is ready to purchase with API documentation and constant provider support.
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

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

Fetch Actionable Transportation Doc Flow Transactions API
4.5
4.5/5
Fetch Actionable Transportation Doc Flow Transactions API offers external data solutions to build products for automating transportation documents and querying all next actions for a given FlowInstanceId purposes. Fetch Actionable Transportation Doc Flow Transactions API by Tradelens is here to offer quality and essential details required for automating transportation documents, tracking containers, digitalizing bills of lading, lowering carrying costs and more related projects.

Tradelens

Transportation Doc Transactions API
4.0
4.0/5
This transportation doc transactions API offers a gigantic volume of Transportation data inclusive of all the elements you require. Transportation Doc Transactions API returns precise automating transportation documents, tracking containers, digitalizing bills of lading, lowering carrying costs and more data for building mobile apps, websites, tools, software, market analysis and much 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.

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.

Sign up for Flexport shipments API

Get Data Access

~[ ∵ ]~

Sign-up Succesful

Wait for the Data