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
| Action | What it does |
|---|---|
| Create contact | Add a contact to a company in your Flexport network. |
| Create product | Add a product to your Flexport product library. |
| Download document | Get a document's file. |
| Get booking | Get a booking's details, including its cargo and the shipment it became. |
| Get invoice | Get an invoice with its line items, totals and balance. |
| Get my company | Get your own company's Flexport profile, with its legal entities. |
| Get product | Get a product from your product library, with its HS codes. |
| Get purchase order | Get a purchase order's details: its parties, dates and terms. |
| Get shipment | Get a shipment's details: its status, dates, parties and cargo. |
| List bookings | List booking requests, filtered by status, shipment or dates. |
| List contacts | List the contacts in your Flexport network, for one company or all. |
| List containers | List ocean containers, newest first, for a shipment or a container number. |
| List customs entries | List customs entries and their release status, for one shipment or all. |
| List documents | List shipment documents, filtered by shipment, type or upload time. |
| List events | List the milestone events Flexport has sent to your webhooks, such as a departure, an arrival or an invoice payment. |
| List invoices | List Flexport's invoices to you, filtered by status, shipment or dates. |
| List products | List the products in your Flexport product library. |
| List purchase orders | List purchase orders, filtered by status, name, shipment or dates. |
| List shipments | List shipments, filtered by status, mode, container, purchase order or SKU. |
| Update contact | Change a contact's name, email or phone number. |
| Update product | Change a product in your product library. |
| Upload document | Attach 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
- Name
nametextRequired - The contact's name.
- Email
emailtextRequired - The contact's email address.
- Phone number
phone_numbertextRequired - The contact's phone number.
- Company
company_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
- Name
nametextRequired - The product's name.
- SKU
skutextRequired - The product's SKU. SKUs are unique among active products.
- Description
descriptiontext - What the product is.
- Category
product_categorytext - The category to file the product under.
- Verified by us
client_verifiedtrue/false - Whether your company has checked this product's details.
- HS codes
hs_codeslist - HS codes for the product in one country, such as 8504.40. They replace the product's existing classifications.
- HS code country
country_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 ID
document_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 ID
booking_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 ID
invoice_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
- Product
product_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 ID
purchase_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
- Shipment
shipment_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
- Status
statustext - Only bookings with this status.One of:
submitted,booked. - Shipment
shipment_idnumber - Choose a shipment, or enter its Flexport ID.
- Cargo ready from
cargo_ready_fromdate - Only bookings whose cargo is ready on or after this date.
- Cargo ready until
cargo_ready_todate - Only bookings whose cargo is ready on or before this date.
- Created after
created_afterdate and time - Only bookings made after this time.
- Sort by
sorttext - What to sort the bookings by.One of:
created_at(Created at),cargo_ready_date(Cargo ready date). - Order
directiontext - Newest or largest first (desc) or oldest or smallest first (asc).One of:
desc,asc. - Page
pagenumber - Which page of results to read, starting at 1.At least 1.
- Results per page
pernumber - 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
- Company
company_idtext - Choose a company in your network, or enter its Flexport ID.
- Page
pagenumber - Which page of results to read, starting at 1.At least 1.
- Results per page
pernumber - 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
- Shipment
shipment_idnumber - Choose a shipment, or enter its Flexport ID.
- Container number
container_numbertext - Only the container with this number.
- Page
pagenumber - Which page of results to read, starting at 1.At least 1.
- Results per page
pernumber - 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
- Shipment
shipment_idtext - Choose a shipment, or enter its Flexport ID.
- Page
pagenumber - Which page of results to read, starting at 1.At least 1.
- Results per page
pernumber - 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
- Shipment
shipment_idnumber - Choose a shipment, or enter its Flexport ID.
- Document type
document_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 after
uploaded_afterdate and time - Only documents uploaded on or after this time.
- Page
pagenumber - Which page of results to read, starting at 1.At least 1.
- Results per page
pernumber - 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 type
typetext - Only events of this type, such as /shipment_leg#arrived.
- Happened after
occurred_afterdate and time - Only events that happened on or after this time.
- Happened before
occurred_beforedate and time - Only events that happened on or before this time.
- Shipment
shipment_idnumber - Choose a shipment, or enter its Flexport ID.
- Page
pagenumber - Which page of results to read, starting at 1.At least 1.
- Results per page
pernumber - 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
- Status
statustext - Only invoices with this status.One of:
outstanding,past_due(Past due),paid,void. - Shipment
shipment_idnumber - Choose a shipment, or enter its Flexport ID.
- Issued after
issued_afterdate and time - Only invoices issued after this time.
- Issued before
issued_beforedate and time - Only invoices issued before this time.
- Updated after
updated_afterdate and time - Only invoices changed after this time.
- Sort by
sorttext - Sort the invoices by due date.One of:
due_date(Due date). - Order
directiontext - Newest or largest first (desc) or oldest or smallest first (asc).One of:
desc,asc. - Page
pagenumber - Which page of results to read, starting at 1.At least 1.
- Results per page
pernumber - 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
- SKU
skutext - Only the product with this SKU.
- Archived
archivedtrue/false - Turn on for archived products only, off for active ones only.
- Page
pagenumber - Which page of results to read, starting at 1.At least 1.
- Results per page
pernumber - 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
- Status
statustext - Only purchase orders with this status.One of:
open,closed,cancelled. - Name
nametext - Only the purchase order with this name.
- Shipment
shipment_idnumber - Choose a shipment, or enter its Flexport ID.
- Archived
archivedtrue/false - Turn on for archived purchase orders only, off for active ones only.
- Updated after
updated_afterdate and time - Only purchase orders changed after this time.
- Created after
created_afterdate and time - Only purchase orders created after this time.
- Sort by
sorttext - Sort the purchase orders by their Flexport ID.One of:
id. - Order
directiontext - Newest or largest first (desc) or oldest or smallest first (asc).One of:
desc,asc. - Page
pagenumber - Which page of results to read, starting at 1.At least 1.
- Results per page
pernumber - 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
- Status
statustext - 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 mode
transportation_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 number
container_numbertext - Only shipments carrying this container number.
- Purchase order number
purchase_ordertext - Only shipments for this purchase order number.
- SKU
skutext - Only shipments carrying the product with this SKU.
- Master bill number
master_bill_numbertext - Only shipments with this master bill of lading number.
- House bill number
house_bill_numbertext - Only shipments with this house bill of lading number.
- Sort by
sorttext - What to sort the shipments by.One of:
id,updated_at(Updated at),status,transportation_mode(Transportation mode),archived_at(Archived at). - Order
directiontext - Newest or largest first (desc) or oldest or smallest first (asc).One of:
desc,asc. - Page
pagenumber - Which page of results to read, starting at 1.At least 1.
- Results per page
pernumber - 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
- Contact
contact_idtextRequired - Choose a contact, or enter its Flexport ID.
- Name
nametext - The contact's new name.
- Email
emailtext - The contact's new email address.
- Phone number
phone_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
- Product
product_idtextRequired - Choose a product, or enter its Flexport ID.
- Name
nametext - The product's name.
- SKU
skutext - The product's SKU. SKUs are unique among active products.
- Description
descriptiontext - What the product is.
- Category
product_categorytext - The category to file the product under.
- Verified by us
client_verifiedtrue/false - Whether your company has checked this product's details.
- HS codes
hs_codeslist - HS codes for the product in one country, such as 8504.40. They replace the product's existing classifications.
- HS code country
country_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
- Shipment
shipment_idnumberRequired - Choose the shipment the document belongs to, or enter its Flexport ID.
- Document type
document_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. - File
filetextRequired - Upload a file, choose one from an earlier step, or enter a link to one.
- File name
file_nametext - The name Flexport shows for the file. Leave empty to keep the file's own name.
- Memo
memotext - 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
}
}