2023-07-01
v3
v2
v1
2023-07-01
Search
General
Authentication
Response Semantics
Pagination
Pagination Parameters
Expansion
Examples
Versioning
Date-based versioning
Backwards-compatible changes
Errors
Metadata
Webhook Endpoints
Setting a Secret Token
Payloads
Response
Terms and Conditions
Changelog
v3 to 2023-07-01
Webhooks
Milestones
Estimated Transit Events
Actual Transit Events
Administrative Events
Invoice Events
Document Events
PurchaseOrder Events
Event
get
List all webhook events
get
Retrieve a single webhook event
4-PL
Carbon Calculation
post
Calculate carbon emissions
Shipment Status
Container
get
List all containers.
get
Retrieve a container.
ContainerLeg
get
List all container legs
get
Retrieve a container leg on an Ocean shipment
Shipment
get
List all shipments
get
Retrieve a shipment
patch
Update an existing shipment
post
Create shareable URLs for shipments
ShipmentLeg
get
List all shipment route legs
get
Retrieve a shipment route leg
Purchase Orders
PurchaseOrderLineItem
get
List all purchase order line items.
get
Retrieve a purchase order line item
PurchaseOrder
get
List all purchase orders
post
Create and return a purchase order
get
Retrieve a purchase order
post
Update and return a purchase order
Booking
BookingAmendment
post
Create a new booking amendment.
BookingLineItem
get
List all booking line items
post
Create a booking line item
get
Retrieves the details of a single booking line item.
Booking
get
List all bookings
post
Create and return a booking
get
Retrieve a booking
Customs
Commercial Invoices
post
Create a commercial invoice
patch
Update a commercial invoice
get
Retrieve a commercial invoice
Customs Entries
get
List customs entry objects
get
Retrieve a customs entry
Customs ISF
post
Create or update an ISF
Invoices
Invoices
get
List all invoices.
get
Retrieve an invoice
Products
Product
get
List all products for a client
post
Create a product
get
Retrieve a single product
patch
Update a product
Network
Company
get
List company objects
post
Create a new company object
get
Retrieve a company
patch
Update an existing company
get
Retrieve your company
CompanyEntity
get
List of company entity objects
post
Create and return a new company entity
get
Retrieve a company entity
patch
Update a company entity
Contact
get
List contact objects
post
Create a new contact object
get
Retrieve a contact
patch
Update an existing contact
Location
get
List of location objects
post
Create and return a new location
get
Retrieve a location by id
patch
Update a network location
Ports
Ports
get
List of ports
Documents
Document Types
Document
get
List document objects
post
Create a document
get
Retrieve a document
get
Download a document
Terms and Conditions
Click here to see the Terms & Conditions for the Flexport API
➔ Next to
Changelog