Flexport

App · 22 actions

Track Flexport shipments, containers and milestones, read bookings, purchase orders, invoices and customs entries, manage products and contacts, and send shipment documents.

Actions

ActionWhat it does
Create contactAdd a contact to a company in your Flexport network.
Create productAdd a product to your Flexport product library.
Download documentGet a document's file.
Get bookingGet a booking's details, including its cargo and the shipment it became.
Get invoiceGet an invoice with its line items, totals and balance.
Get my companyGet your own company's Flexport profile, with its legal entities.
Get productGet a product from your product library, with its HS codes.
Get purchase orderGet a purchase order's details: its parties, dates and terms.
Get shipmentGet a shipment's details: its status, dates, parties and cargo.
List bookingsList booking requests, filtered by status, shipment or dates.
List contactsList the contacts in your Flexport network, for one company or all.
List containersList ocean containers, newest first, for a shipment or a container number.
List customs entriesList customs entries and their release status, for one shipment or all.
List documentsList shipment documents, filtered by shipment, type or upload time.
List eventsList the milestone events Flexport has sent to your webhooks, such as a departure, an arrival or an invoice payment.
List invoicesList Flexport's invoices to you, filtered by status, shipment or dates.
List productsList the products in your Flexport product library.
List purchase ordersList purchase orders, filtered by status, name, shipment or dates.
List shipmentsList shipments, filtered by status, mode, container, purchase order or SKU.
Update contactChange a contact's name, email or phone number.
Update productChange a product in your product library.
Upload documentAttach a document, such as a commercial invoice or packing list, to a shipment.

Create contact

Add a contact to a company in your Flexport network.

Inputs

NamenametextRequired
The contact's name.
EmailemailtextRequired
The contact's email address.
Phone numberphone_numbertextRequired
The contact's phone number.
Companycompany_idtext
Choose the company the contact works for. Leave empty for your own company.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "company": {},
      "email": "example",
      "id": "example",
      "name": "example",
      "phone_number": "example"
    },
    "self": "example",
    "version": 1
  }
}

Create product

Add a product to your Flexport product library.

Inputs

NamenametextRequired
The product's name.
SKUskutextRequired
The product's SKU. SKUs are unique among active products.
Descriptiondescriptiontext
What the product is.
Categoryproduct_categorytext
The category to file the product under.
Verified by usclient_verifiedtrue/false
Whether your company has checked this product's details.
HS codeshs_codeslist
HS codes for the product in one country, such as 8504.40. They replace the product's existing classifications.
HS code countrycountry_codetext
The country the HS codes are for.One of: AD (Andorra), AE (United Arab Emirates), AF (Afghanistan), AG (Antigua & Barbuda), AI (Anguilla), AL (Albania), AM (Armenia), AO (Angola), AQ (Antarctica), AR (Argentina), and 240 more.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "archived_at": "example",
      "classifications": [
        {}
      ],
      "client_verified": true,
      "description": "example",
      "id": 1,
      "name": "example",
      "product_category": "example",
      "product_properties": [
        {}
      ],
      "sku": "example"
    },
    "self": "example",
    "version": 1
  }
}

Download document

Get a document's file. It comes back as Base64 text with its media type.

Inputs

Document IDdocument_idtextRequired
The document's Flexport ID, from List documents.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}

Get booking

Get a booking's details, including its cargo and the shipment it became.

Inputs

Booking IDbooking_idnumberRequired
The booking's Flexport ID.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "cargo_ready_date": "example",
      "created_at": "example",
      "delivery_date": "example",
      "id": 1,
      "metadata": {},
      "name": "example",
      "quote_status": "example",
      "shipment": {},
      "status": "example",
      "transportation_mode": "example",
      "updated_at": "example"
    },
    "self": "example",
    "version": 1
  }
}

Get invoice

Get an invoice with its line items, totals and balance.

Inputs

Invoice IDinvoice_idtextRequired
The invoice's Flexport ID.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "balance": {
        "_object": "example",
        "amount": "example",
        "currency_code": "example"
      },
      "due_date": "example",
      "id": "example",
      "invoice_type": "example",
      "issued_at": "example",
      "items": [
        {}
      ],
      "last_updated_at": "example",
      "name": "example",
      "status": "example",
      "total": {
        "_object": "example",
        "amount": "example",
        "currency_code": "example"
      },
      "type": "example",
      "voided_at": "example"
    },
    "self": "example",
    "version": 1
  }
}

Get my company

Get your own company's Flexport profile, with its legal entities.

Inputs

None.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "editable": true,
      "entities": [
        {}
      ],
      "id": "example",
      "name": "example",
      "ref": "example"
    },
    "self": "example",
    "version": 1
  }
}

Get product

Get a product from your product library, with its HS codes.

Inputs

Productproduct_idtextRequired
Choose a product, or enter its Flexport ID.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "archived_at": "example",
      "classifications": [
        {}
      ],
      "client_verified": true,
      "description": "example",
      "id": 1,
      "name": "example",
      "product_category": "example",
      "product_properties": [
        {}
      ],
      "sku": "example"
    },
    "self": "example",
    "version": 1
  }
}

Get purchase order

Get a purchase order's details: its parties, dates and terms.

Inputs

Purchase order IDpurchase_order_idnumberRequired
The purchase order's Flexport ID.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "archived_at": "example",
      "cargo_ready_date": "example",
      "created_at": "example",
      "id": 1,
      "incoterm": "example",
      "issue_date": "example",
      "memo": "example",
      "metadata": {},
      "must_arrive_date": "example",
      "name": "example",
      "order_class": "example",
      "order_type": "example",
      "parties": [
        {}
      ],
      "priority": "example",
      "status": "example",
      "transportation_mode": "example",
      "updated_at": "example"
    },
    "self": "example",
    "version": 1
  }
}

Get shipment

Get a shipment's details: its status, dates, parties and cargo.

Inputs

Shipmentshipment_idtextRequired
Choose a shipment, or enter its Flexport ID.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "actual_arrival_date": "example",
      "actual_delivered_in_full_date": "example",
      "actual_departure_date": "example",
      "booking": {},
      "cargo_ready_date": "example",
      "created_date": "example",
      "estimated_arrival_date": "example",
      "estimated_delivered_in_full_date": "example",
      "estimated_departure_date": "example",
      "freight_type": "example",
      "id": 1,
      "incoterm": "example",
      "metadata": {},
      "name": "example",
      "pieces": 1,
      "priority": "example",
      "status": "example",
      "target_delivery_date": "example",
      "transportation_mode": "example",
      "updated_at": "example"
    },
    "self": "example",
    "version": 1
  }
}

List bookings

List booking requests, filtered by status, shipment or dates.

Inputs

Statusstatustext
Only bookings with this status.One of: submitted, booked.
Shipmentshipment_idnumber
Choose a shipment, or enter its Flexport ID.
Cargo ready fromcargo_ready_fromdate
Only bookings whose cargo is ready on or after this date.
Cargo ready untilcargo_ready_todate
Only bookings whose cargo is ready on or before this date.
Created aftercreated_afterdate and time
Only bookings made after this time.
Sort bysorttext
What to sort the bookings by.One of: created_at (Created at), cargo_ready_date (Cargo ready date).
Orderdirectiontext
Newest or largest first (desc) or oldest or smallest first (asc).One of: desc, asc.
Pagepagenumber
Which page of results to read, starting at 1.At least 1.
Results per pagepernumber
How many results to read per page, up to 100. Flexport sends 20 when this is empty.From 1 to 100.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "data": [
        {
          "_object": "example",
          "cargo_ready_date": "example",
          "created_at": "example",
          "delivery_date": "example",
          "id": 1,
          "metadata": {},
          "name": "example",
          "quote_status": "example",
          "shipment": {},
          "status": "example",
          "transportation_mode": "example",
          "updated_at": "example"
        }
      ],
      "next": "example",
      "prev": "example"
    },
    "self": "example",
    "version": 1
  }
}

List contacts

List the contacts in your Flexport network, for one company or all.

Inputs

Companycompany_idtext
Choose a company in your network, or enter its Flexport ID.
Pagepagenumber
Which page of results to read, starting at 1.At least 1.
Results per pagepernumber
How many results to read per page, up to 100. Flexport sends 20 when this is empty.From 1 to 100.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "data": [
        {
          "_object": "example",
          "company": {},
          "email": "example",
          "id": "example",
          "name": "example",
          "phone_number": "example"
        }
      ],
      "next": "example",
      "prev": "example"
    },
    "self": "example",
    "version": 1
  }
}

List containers

List ocean containers, newest first, for a shipment or a container number.

Inputs

Shipmentshipment_idnumber
Choose a shipment, or enter its Flexport ID.
Container numbercontainer_numbertext
Only the container with this number.
Pagepagenumber
Which page of results to read, starting at 1.At least 1.
Results per pagepernumber
How many results to read per page, up to 100. Flexport sends 20 when this is empty.From 1 to 100.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "data": [
        {
          "_object": "example",
          "actual_arrival_date": "example",
          "actual_delivery_date": "example",
          "actual_departure_date": "example",
          "container_number": "example",
          "container_size": "example",
          "container_type": "example",
          "estimated_arrival_date": "example",
          "estimated_delivery_date": "example",
          "estimated_departure_date": "example",
          "id": 1,
          "last_free_day_date": "example",
          "seal_number": "example",
          "shipment": {}
        }
      ],
      "next": "example",
      "prev": "example"
    },
    "self": "example",
    "version": 1
  }
}

List customs entries

List customs entries and their release status, for one shipment or all.

Inputs

Shipmentshipment_idtext
Choose a shipment, or enter its Flexport ID.
Pagepagenumber
Which page of results to read, starting at 1.At least 1.
Results per pagepernumber
How many results to read per page, up to 100. Flexport sends 20 when this is empty.From 1 to 100.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "data": [
        {
          "_object": "example",
          "entry_number": "example",
          "id": "example",
          "release_date": "example",
          "release_status": "example",
          "shipment": {}
        }
      ],
      "next": "example",
      "prev": "example"
    },
    "self": "example",
    "version": 1
  }
}

List documents

List shipment documents, filtered by shipment, type or upload time.

Inputs

Shipmentshipment_idnumber
Choose a shipment, or enter its Flexport ID.
Document typedocument_typetext
Only documents of this type.One of: commercial_invoice (Commercial invoice), packing_list (Packing list), commercial_invoice_packing_list (Commercial invoice packing list), bill_of_lading (Bill of lading), house_bill_of_lading_draft (House bill of lading draft), air_waybill (Air waybill), arrival_notice (Arrival notice), certificate_of_origin (Certificate of origin), certificate_of_insurance (Certificate of insurance), material_safety_data_sheet_msds (Material safety data sheet msds), and 6 more.
Uploaded afteruploaded_afterdate and time
Only documents uploaded on or after this time.
Pagepagenumber
Which page of results to read, starting at 1.At least 1.
Results per pagepernumber
How many results to read per page, up to 100. Flexport sends 20 when this is empty.From 1 to 100.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "data": [
        {
          "_object": "example",
          "archived_at": "example",
          "document_type": "example",
          "file_link": "example",
          "file_metadata": {},
          "file_name": "example",
          "id": "example",
          "memo": "example",
          "shipment": {}
        }
      ],
      "next": "example",
      "prev": "example"
    },
    "self": "example",
    "version": 1
  }
}

List events

List the milestone events Flexport has sent to your webhooks, such as a departure, an arrival or an invoice payment.

Inputs

Event typetypetext
Only events of this type, such as /shipment_leg#arrived.
Happened afteroccurred_afterdate and time
Only events that happened on or after this time.
Happened beforeoccurred_beforedate and time
Only events that happened on or before this time.
Shipmentshipment_idnumber
Choose a shipment, or enter its Flexport ID.
Pagepagenumber
Which page of results to read, starting at 1.At least 1.
Results per pagepernumber
How many results to read per page, up to 100. Flexport sends 20 when this is empty.From 1 to 100.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "data": [
        {
          "_object": "example",
          "created_at": "example",
          "data": {},
          "id": 1,
          "occurred_at": "example",
          "type": "example",
          "version": 1
        }
      ],
      "next": "example",
      "prev": "example"
    },
    "self": "example",
    "version": 1
  }
}

List invoices

List Flexport's invoices to you, filtered by status, shipment or dates.

Inputs

Statusstatustext
Only invoices with this status.One of: outstanding, past_due (Past due), paid, void.
Shipmentshipment_idnumber
Choose a shipment, or enter its Flexport ID.
Issued afterissued_afterdate and time
Only invoices issued after this time.
Issued beforeissued_beforedate and time
Only invoices issued before this time.
Updated afterupdated_afterdate and time
Only invoices changed after this time.
Sort bysorttext
Sort the invoices by due date.One of: due_date (Due date).
Orderdirectiontext
Newest or largest first (desc) or oldest or smallest first (asc).One of: desc, asc.
Pagepagenumber
Which page of results to read, starting at 1.At least 1.
Results per pagepernumber
How many results to read per page, up to 100. Flexport sends 20 when this is empty.From 1 to 100.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "data": [
        {
          "_object": "example",
          "balance": {
            "_object": "example",
            "amount": "example",
            "currency_code": "example"
          },
          "due_date": "example",
          "id": "example",
          "invoice_type": "example",
          "issued_at": "example",
          "items": [
            {}
          ],
          "last_updated_at": "example",
          "name": "example",
          "status": "example",
          "total": {
            "_object": "example",
            "amount": "example",
            "currency_code": "example"
          },
          "type": "example",
          "voided_at": "example"
        }
      ],
      "next": "example",
      "prev": "example"
    },
    "self": "example",
    "version": 1
  }
}

List products

List the products in your Flexport product library.

Inputs

SKUskutext
Only the product with this SKU.
Archivedarchivedtrue/false
Turn on for archived products only, off for active ones only.
Pagepagenumber
Which page of results to read, starting at 1.At least 1.
Results per pagepernumber
How many results to read per page, up to 100. Flexport sends 20 when this is empty.From 1 to 100.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "data": [
        {
          "_object": "example",
          "archived_at": "example",
          "classifications": [
            {}
          ],
          "client_verified": true,
          "description": "example",
          "id": 1,
          "name": "example",
          "product_category": "example",
          "product_properties": [
            {}
          ],
          "sku": "example"
        }
      ],
      "next": "example",
      "prev": "example"
    },
    "self": "example",
    "version": 1
  }
}

List purchase orders

List purchase orders, filtered by status, name, shipment or dates.

Inputs

Statusstatustext
Only purchase orders with this status.One of: open, closed, cancelled.
Namenametext
Only the purchase order with this name.
Shipmentshipment_idnumber
Choose a shipment, or enter its Flexport ID.
Archivedarchivedtrue/false
Turn on for archived purchase orders only, off for active ones only.
Updated afterupdated_afterdate and time
Only purchase orders changed after this time.
Created aftercreated_afterdate and time
Only purchase orders created after this time.
Sort bysorttext
Sort the purchase orders by their Flexport ID.One of: id.
Orderdirectiontext
Newest or largest first (desc) or oldest or smallest first (asc).One of: desc, asc.
Pagepagenumber
Which page of results to read, starting at 1.At least 1.
Results per pagepernumber
How many results to read per page, up to 100. Flexport sends 20 when this is empty.From 1 to 100.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "data": [
        {
          "_object": "example",
          "archived_at": "example",
          "cargo_ready_date": "example",
          "created_at": "example",
          "id": 1,
          "incoterm": "example",
          "issue_date": "example",
          "memo": "example",
          "metadata": {},
          "must_arrive_date": "example",
          "name": "example",
          "order_class": "example",
          "order_type": "example",
          "parties": [
            {}
          ],
          "priority": "example",
          "status": "example",
          "transportation_mode": "example",
          "updated_at": "example"
        }
      ],
      "next": "example",
      "prev": "example"
    },
    "self": "example",
    "version": 1
  }
}

List shipments

List shipments, filtered by status, mode, container, purchase order or SKU.

Inputs

Statusstatustext
Only shipments at this stage.One of: seller_location (Seller location), origin_stop_off (Origin stop off), in_transit_to_departure_port (In transit to departure port), departure_port (Departure port), in_transit_to_intermediary_port (In transit to intermediary port), intermediary_port (Intermediary port), in_transit_to_arrival_port (In transit to arrival port), arrival_port (Arrival port), deconsolidation, in_transit_to_final_destination (In transit to final destination), and 3 more.
Transportation modetransportation_modetext
Only shipments that travel this way.One of: ocean, air, barge, truck, rail, unknown_transportation (Unknown transportation), ocean_air (Ocean air), truck_intl (Truck intl), warehouse_storage (Warehouse storage).
Container numbercontainer_numbertext
Only shipments carrying this container number.
Purchase order numberpurchase_ordertext
Only shipments for this purchase order number.
SKUskutext
Only shipments carrying the product with this SKU.
Master bill numbermaster_bill_numbertext
Only shipments with this master bill of lading number.
House bill numberhouse_bill_numbertext
Only shipments with this house bill of lading number.
Sort bysorttext
What to sort the shipments by.One of: id, updated_at (Updated at), status, transportation_mode (Transportation mode), archived_at (Archived at).
Orderdirectiontext
Newest or largest first (desc) or oldest or smallest first (asc).One of: desc, asc.
Pagepagenumber
Which page of results to read, starting at 1.At least 1.
Results per pagepernumber
How many results to read per page, up to 100. Flexport sends 20 when this is empty.From 1 to 100.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "data": [
        {
          "_object": "example",
          "actual_arrival_date": "example",
          "actual_delivered_in_full_date": "example",
          "actual_departure_date": "example",
          "booking": {},
          "cargo_ready_date": "example",
          "created_date": "example",
          "estimated_arrival_date": "example",
          "estimated_delivered_in_full_date": "example",
          "estimated_departure_date": "example",
          "freight_type": "example",
          "id": 1,
          "incoterm": "example",
          "metadata": {},
          "name": "example",
          "pieces": 1,
          "priority": "example",
          "status": "example",
          "target_delivery_date": "example",
          "transportation_mode": "example",
          "updated_at": "example"
        }
      ],
      "next": "example",
      "prev": "example"
    },
    "self": "example",
    "version": 1
  }
}

Update contact

Change a contact's name, email or phone number. Fields left empty stay as they are.

Inputs

Contactcontact_idtextRequired
Choose a contact, or enter its Flexport ID.
Namenametext
The contact's new name.
Emailemailtext
The contact's new email address.
Phone numberphone_numbertext
The contact's new phone number.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "company": {},
      "email": "example",
      "id": "example",
      "name": "example",
      "phone_number": "example"
    },
    "self": "example",
    "version": 1
  }
}

Update product

Change a product in your product library. Fields left empty stay as they are.

Inputs

Productproduct_idtextRequired
Choose a product, or enter its Flexport ID.
Namenametext
The product's name.
SKUskutext
The product's SKU. SKUs are unique among active products.
Descriptiondescriptiontext
What the product is.
Categoryproduct_categorytext
The category to file the product under.
Verified by usclient_verifiedtrue/false
Whether your company has checked this product's details.
HS codeshs_codeslist
HS codes for the product in one country, such as 8504.40. They replace the product's existing classifications.
HS code countrycountry_codetext
The country the HS codes are for.One of: AD (Andorra), AE (United Arab Emirates), AF (Afghanistan), AG (Antigua & Barbuda), AI (Anguilla), AL (Albania), AM (Armenia), AO (Angola), AQ (Antarctica), AR (Argentina), and 240 more.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "archived_at": "example",
      "classifications": [
        {}
      ],
      "client_verified": true,
      "description": "example",
      "id": 1,
      "name": "example",
      "product_category": "example",
      "product_properties": [
        {}
      ],
      "sku": "example"
    },
    "self": "example",
    "version": 1
  }
}

Upload document

Attach a document, such as a commercial invoice or packing list, to a shipment.

Inputs

Shipmentshipment_idnumberRequired
Choose the shipment the document belongs to, or enter its Flexport ID.
Document typedocument_typetextRequired
What kind of document this is.One of: commercial_invoice (Commercial invoice), packing_list (Packing list), commercial_invoice_packing_list (Commercial invoice packing list), bill_of_lading (Bill of lading), house_bill_of_lading_draft (House bill of lading draft), air_waybill (Air waybill), arrival_notice (Arrival notice), certificate_of_origin (Certificate of origin), certificate_of_insurance (Certificate of insurance), material_safety_data_sheet_msds (Material safety data sheet msds), and 6 more.
FilefiletextRequired
Upload a file, choose one from an earlier step, or enter a link to one.
File namefile_nametext
The name Flexport shows for the file. Leave empty to keep the file's own name.
Memomemotext
A note to go with the document.

Outputs

dataobject
The response from Flexport.
Example output
{
  "data": {
    "_object": "example",
    "data": {
      "_object": "example",
      "archived_at": "example",
      "document_type": "example",
      "file_link": "example",
      "file_metadata": {},
      "file_name": "example",
      "id": "example",
      "memo": "example",
      "shipment": {}
    },
    "self": "example",
    "version": 1
  }
}

On this page