This page describes the different event types which will trigger a Event object to be sent to your registered Webhook Endpoints. Milestones designated with an asterisk are available upon request.
For all Estimated Transit Events, the data field of the Event webook payload is a Shipment Event Data object.
| Name | Type | Description | Resource | Location |
|---|---|---|---|---|
| Schedule Confirmed | /shipment#schedule_confirmed |
Estimated departure and arrival dates set for each specified location. | Shipment | None |
| Updated Estimated Time of Departure (ETD)* | /shipment_leg#updated_estimated_time_of_departure |
Revised estimate of date when shipment will depart from specified location. | ShipmentLeg | departure location |
| Updated Estimated Time of Arrival (ETA)* | /shipment_leg#updated_estimated_time_of_arrival |
Revised estimate of date when shipment will arrive at specified location. | ShipmentLeg | arrival location |
| Updated Estimated Out for Delivery* | /shipment_leg#updated_estimated_out_for_delivery |
Revised estimate of date when shipment is out for delivery. | ShipmentLeg | departure location |
| Updated Route (This milestone is still under development)* | /shipment#updated_route |
Updated route to final destination, such as changes to intermediary locations or ports. | Shipment | None |
| Updated Estimated Available for Pickup* | /shipment_container_leg#updated_estimated_available_for_pickup |
Revised estimated of date when shipment will be ready for pickup at the port of delivery. | ContainerLeg | departure location |
For all Actual Transit Events, the data field of the Event webhook payload is a Shipment Event Data object.
| Name | Type | Description | Resource | Location |
|---|---|---|---|---|
| Actual Time of Arrival (ATA) | /shipment_leg#arrived |
Shipment arrived at specified location. | ShipmentLeg | arrival location |
| Actual Time of Departure (ATD) | /shipment_leg#departed |
Shipment departed from specified location. | ShipmentLeg | departure location |
| Actual Out for Delivery* | /shipment_leg#out_for_delivery |
Shipment departed and is out for delivery | ShipmentLeg | departure location |
| Delivery Complete* | /shipment_leg#delivery_completed |
Shipment delivery is complete | ShipmentLeg | destination location |
| Loaded on Board* | /ocean/shipment_container_leg#loaded_on_board |
Shipment container loaded on vessel or rail. | ContainerLeg | where the container was loaded |
| Loaded on Truck* | /ocean/shipment_leg#loaded_on_truck |
Cargo has been transloaded from shipment container to truck. | ShipmentLeg | where the cargo was loaded on the truck |
| Unloaded off Board* | /ocean/shipment_container_leg#unloaded_off_board |
Shipment container discharged from vessel or rail. | ContainerLeg | where the container was unloaded |
| Arrived at Delivery Location | /shipment_leg#delivered |
Part of a shipment delivered to final destination. | ShipmentLeg | delivery location |
| Delivered in Full | /shipment#delivered_in_full |
Entire shipment delivered to final destination, e.g. multi-container shipments. | Shipment | shipment final destination |
For all Administrative Events, the data field of the Event webhook payload is a Shipment Event Data object.
| Name | Type | Description | Resource | Location |
|---|---|---|---|---|
| Shipment Created | /shipment#created |
User has confirmed Flexport quote and cargo is getting ready to ship. | Shipment | None |
| Air Booking Confirmed* | /shipment#booking_confirmed |
Shipment is booked with the air carrier. | Shipment | None |
| Updated Cargo Ready Date | /shipment#cargo_ready_date_changed |
Cargo ready date changed from the original cargo ready date. | Shipment | None |
| Documents Sent to Nominated Broker | /shipment#documents_sent_to_nominated_broker |
Arrival notice sent to client-nominated customs broker. Applicable to non-Flexport customs service shipments only. | Shipment | None |
| Commercial Invoices Digitized | /shipments#commercial_invoices_digitized |
All commercial invoices have been entered into the Flexport system | Shipment | None |
| Container Available* | /ocean/shipment_container_leg#available_for_pickup |
Container becomes available for pickup from port. | ContainerLeg | location of the container |
| Delivery Appointment Requested* | /shipment_leg#delivery_appointment_requested |
Date the delivery appointment was requested. | ShipmentLeg | delivery location |
| Delivery Appointment Scheduled | /shipment_leg#delivery_appointment_scheduled |
Date of the scheduled delivery appointment. | ShipmentLeg | delivery location |
| Filing Submitted for in Bond Transportation | /shipment#filing_submitted_for_in_bond_transportation |
Date when the filing was submitted. | Shipment | None |
| Free Time to Expire | /ocean/shipment_container#free_time_to_expire |
Date when container free time expires. | Container | location of where the container will be when the container free time expires |
| Free Time Expired | /ocean/shipment_container#free_time_expired |
Date when container free time expired. | Container | location of the container |
| FTZ Admission | /shipment#ftz_admission |
Date when carrier is informed that the posted bill has been placed on a FTZ admission. | Shipment | |
| Empty Equipment Returned | /ocean/shipment_container#empty_returned |
Empty container returned to carrier. | Container | location of the container |
| [DEPRECATED] Delivery Appointment Scheduled | /shipment_container_leg#delivery_appointment_scheduled |
Date and time of the scheduled delivery appointment. | ContainerLeg | delivery location |
| Flight Delay: Mechanical Problem | /shipment#flight_delay_mechanical |
Delay due to mechanical issue with the airplane. | Shipment | |
| Flight Delay: Schedule Updated By Carrier | /shipment#flight_delay_schedule_updated_by_carrier |
Delay due to a flight schedule change made by the carrier. | Shipment | |
| Late Bill of Lading Release | /shipment#late_bill_of_lading_release |
Delay due to late bill of lading release. | Shipment | |
| Missed Appointment | /shipment#missed_appointment |
Delivery not completed due to missed appointment. | Shipment | |
| Ocean Port Dwell Delay | /shipment#ocean_port_dwell_delay |
Delay due to dwell at ocean port. | Shipment | |
| Port Strike Delay | /shipment#port_strike_delay |
Delay due to port strike. | Shipment | |
| Vessel Delay: Mechanical Problem | /shipment#vessel_delay_mechanical |
Delay due to mechanical issue with the vessel. | Shipment | |
| Warehouse Devan Delay | /shipment#warehouse_devan_delay |
Delay due to warehouse devan. | Shipment | |
| (Deconsolidation WH) Schedule delay: Trucking - Pending Linehaul Consolidation | /shipment#_deconsolidation_wh_schedule_delay_trucking_pending_linehaul_consolidation |
(Deconsolidation WH) Schedule delay: Trucking - Pending Linehaul Consolidation | Shipment | |
| (Destination Port Dwell) Schedule delay: Client - Pending Consignee Pickup | /shipment#_destination_port_dwell_schedule_delay_client_pending_consignee_pickup |
(Destination Port Dwell) Schedule delay: Client - Pending Consignee Pickup | Shipment | |
| (Destination Port Dwell) Schedule delay: Customs - Customs Exam | /shipment#_destination_port_dwell_schedule_delay_customs_customs_exam |
(Destination Port Dwell) Schedule delay: Customs - Customs Exam | Shipment | |
| (Destination Port Dwell) Schedule delay: Force Majeure - Weather Delay | /shipment#_destination_port_dwell_schedule_delay_force_majeure_weather_delay |
(Destination Port Dwell) Schedule delay: Force Majeure - Weather Delay | Shipment | |
| (Destination Port Dwell) Schedule delay: Trucking - Mechanical Problem | /shipment#_destination_port_dwell_schedule_delay_trucking_mechanical_problem |
(Destination Port Dwell) Schedule delay: Trucking - Mechanical Problem | Shipment | |
| (Destination Port Dwell) Schedule delay: Trucking - Operational mistake by trucker | /shipment#_destination_port_dwell_schedule_delay_trucking_operational_mistake_by_trucker |
(Destination Port Dwell) Schedule delay: Trucking - Operational mistake by trucker | Shipment | |
| (Destination Port Dwell) Schedule delay: Unavailable - Container Damaged | /shipment#_destination_port_dwell_schedule_delay_unavailable_container_damaged |
(Destination Port Dwell) Schedule delay: Unavailable - Container Damaged | Shipment | |
| (Destination Port Dwell) Schedule delay: Unavailable - Container physically inaccessible for pickup | /shipment#_destination_port_dwell_schedule_delay_unavailable_container_physically_inaccessible_for_pickup |
(Destination Port Dwell) Schedule delay: Unavailable - Container physically inaccessible for pickup | Shipment | |
| (Destination Port Dwell) Schedule delay: Unavailable - No Pickup Appointments Available | /shipment#_destination_port_dwell_schedule_delay_unavailable_no_pickup_appointments_available |
(Destination Port Dwell) Schedule delay: Unavailable - No Pickup Appointments Available | Shipment | |
| (Destination Port Dwell) Schedule delay: Unavailable - Unable to Locate | /shipment#_destination_port_dwell_schedule_delay_unavailable_unable_to_locate |
(Destination Port Dwell) Schedule delay: Unavailable - Unable to Locate | Shipment | |
| (LCL Consolidation) Schedule delay: Client - Unable to load on vessel due to shipper or client delay | /shipment#_lcl_consolidation_schedule_delay_client_unable_to_load_on_vessel_due_to_shipper_or_client_delay |
(LCL Consolidation) Schedule delay: Client - Unable to load on vessel due to shipper or client delay | Shipment | |
| (Network Final Delivery) Schedule delay: Client - Warehouse Rescheduled | /shipment#_network_final_delivery_schedule_delay_client_warehouse_rescheduled |
(Network Final Delivery) Schedule delay: Client - Warehouse Rescheduled | Shipment | |
| (Ocean Final Delivery) Schedule delay: Client - Delivery Location Changed | /shipment#_ocean_final_delivery_schedule_delay_client_delivery_location_changed |
(Ocean Final Delivery) Schedule delay: Client - Delivery Location Changed | Shipment | |
| (Ocean Final Delivery) Schedule delay: Customs - Customs Exam | /shipment#_ocean_final_delivery_schedule_delay_customs_customs_exam |
(Ocean Final Delivery) Schedule delay: Customs - Customs Exam | Shipment | |
| (Ocean Final Delivery) Schedule delay: Operator Mistake - flexGO | /shipment#_ocean_final_delivery_schedule_delay_operator_mistake_flexgo |
(Ocean Final Delivery) Schedule delay: Operator Mistake - flexGO | Shipment | |
| (Ocean Final Delivery) Schedule delay: Trucking - Operational mistake by trucker | /shipment#_ocean_final_delivery_schedule_delay_trucking_operational_mistake_by_trucker |
(Ocean Final Delivery) Schedule delay: Trucking - Operational mistake by trucker | Shipment | |
| (Ocean Origin Pickup) Schedule delay: Client - Early pickup/storage request | /shipment#_ocean_origin_pickup_schedule_delay_client_early_pickup_request |
(Ocean Origin Pickup) Schedule delay: Client - Early pickup/storage request | Shipment | |
| (Ocean Origin Pickup) Schedule delay: Other - Please leave detailed reasons in notes | /shipment#_ocean_origin_pickup_schedule_delay_other_please_leave_detailed_reasons_in_notes |
(Ocean Origin Pickup) Schedule delay: Other - Please leave detailed reasons in notes | Shipment | |
| (Ocean Origin Pickup) Schedule delay: Trucking - Operational mistake by trucker | /shipment#_ocean_origin_pickup_schedule_delay_trucking_operational_mistake_by_trucker |
(Ocean Origin Pickup) Schedule delay: Trucking - Operational mistake by trucker | Shipment | |
| (Origin Port Dwell) Schedule delay: Carrier - Change of vessel due to Port Omit | /shipment#_origin_port_dwell_schedule_delay_carrier_change_of_vessel_due_to_port_omit |
(Origin Port Dwell) Schedule delay: Carrier - Change of vessel due to Port Omit | Shipment | |
| (Origin Port Dwell) Schedule delay: Carrier - Delay in vessel departure | /shipment#_origin_port_dwell_schedule_delay_carrier_delay_in_vessel_departure |
(Origin Port Dwell) Schedule delay: Carrier - Delay in vessel departure | Shipment | |
| (Origin Port Dwell) Schedule delay: Client - Request to hold shipment at origin | /shipment#_origin_port_dwell_schedule_delay_client_request_to_hold_shipment_at_origin |
(Origin Port Dwell) Schedule delay: Client - Request to hold shipment at origin | Shipment | |
| (Origin Port Dwell) Schedule delay: Client - Unable to load on vessel due to shipper or client delay | /shipment#_origin_port_dwell_schedule_delay_client_unable_to_load_on_vessel_due_to_shipper_or_client_delay |
(Origin Port Dwell) Schedule delay: Client - Unable to load on vessel due to shipper or client delay | Shipment | |
| (Origin Port Dwell) Schedule delay: Operator Mistake | /shipment#_origin_port_dwell_schedule_delay_operator_mistake |
(Origin Port Dwell) Schedule delay: Operator Mistake | Shipment | |
| (Origin Port Dwell) Schedule delay: Trucking - Operational mistake by trucker | /shipment#_origin_port_dwell_schedule_delay_trucking_operational_mistake_by_trucker |
(Origin Port Dwell) Schedule delay: Trucking - Operational mistake by trucker | Shipment | |
| FID 63495 - All Documents Received from Shipper | /shipment#all_documents_received_from_shipper |
FID 63495 - All Documents Received from Shipper | Shipment | |
| FID 63495 - Booking Request and Shipper Documents Mismatch | /shipment#booking_request_and_shipper_documents_mismatch |
FID 63495 - Booking Request and Shipper Documents Mismatch | Shipment | |
| Cargo Breakdown Delay | /shipment#cargo_breakdown_delay |
Cargo Breakdown Delay | Shipment | |
| Cargo Bumped From Booked Flight | /shipment#cargo_bumped_from_booked_flight |
Cargo Bumped From Booked Flight | Shipment | |
| Cargo Contamination Delay | /shipment#cargo_contamination_delay |
Cargo Contamination Delay | Shipment | |
| Cargo Declaration Mismatch | /shipment#cargo_declaration_mismatch |
Cargo Declaration Mismatch | Shipment | |
| Cargo Not Available | /shipment#cargo_not_available |
Cargo Not Available | Shipment | |
| Cargo Ready Date Changed | /shipment#cargo_ready_date_changed_exception |
Cargo Ready Date Changed | Shipment | |
| Cargo Ready Date Unknown | /shipment#cargo_ready_date_unconfirmed |
Cargo Ready Date Unknown | Shipment | |
| FID 63495 - Cargo Received After Cutoff | /shipment#cargo_received_after_cutoff |
FID 63495 - Cargo Received After Cutoff | Shipment | |
| Cargo Rolled from Booked Vessel | /shipment#cargo_rolled_from_booked_vessel |
Cargo Rolled from Booked Vessel | Shipment | |
| Carrier Refused/Bumped DG Shipment | /shipment#carrier_refused_bumped_dg_shipment |
Carrier Refused/Bumped DG Shipment | Shipment | |
| Flight Delay: Congestion at Transit Port | /shipment#congestion_at_transit_port |
Flight Delay: Congestion at Transit Port | Shipment | |
| Consignee related House Bill of Lading release delay | /shipment#consignee_related_house_bill_of_lading_release_delay |
Consignee related House Bill of Lading release delay | Shipment | |
| Carrier Freight Hold | /shipment#container_carrier_hold |
Carrier Freight Hold | Shipment | |
| Container Hold: Customs | /shipment#container_customs_hold |
Container Hold: Customs | Shipment | |
| Discharge Delay at Rail Yard | /shipment#container_discharge_delay |
Discharge Delay at Rail Yard | Shipment | |
| Container Hold: Other | /shipment#container_hold_other |
Container Hold: Other | Shipment | |
| Shipment Under Consumer Product Safety Commission (CPSC) Review - Hold Cargo Intact | /shipment#cpsc_hold |
Shipment Under Consumer Product Safety Commission (CPSC) Review - Hold Cargo Intact | Shipment | |
| CPSC Hold Removed | /shipment#cpsc_hold_removed |
CPSC Hold Removed | Shipment | |
| Shipment Under Customs Agricultural Hold - Hold Cargo Intact | /shipment#customs_agriculture_hold |
Shipment Under Customs Agricultural Hold - Hold Cargo Intact | Shipment | |
| Shipment Under Customs Agricultural Exam - Hold Cargo Intact | /shipment#customs_agriculture_hold_exam |
Shipment Under Customs Agricultural Exam - Hold Cargo Intact | Shipment | |
| Customs Agriculture Hold Removed | /shipment#customs_agriculture_hold_removed |
Customs Agriculture Hold Removed | Shipment | |
| Release Status Change: Pending Intensive Exam | /shipment#customs_entry_release_status_pending_intensive_exam |
Release Status Change: Pending Intensive Exam | Shipment | |
| Customs entry released | /shipment#customs_entry_release_status_released |
Customs entry released | Shipment | |
| FID 63495 - Customs Hold: Contains Goods with Export Restrictions | /shipment#customs_hold_contains_goods_with_export_restrictions |
FID 63495 - Customs Hold: Contains Goods with Export Restrictions | Shipment | |
| Delivery Appointment Confirmed | /shipment#delivery_appointment_confirmed |
Delivery Appointment Confirmed | Shipment | |
| Delivery Appointment Updated | /shipment#delivery_appointment_updated |
Delivery Appointment Updated | Shipment | |
| Delivery Cancelled: Wrong Delivery Address | /shipment#delivery_cancelled_wrong_delivery_address |
Delivery Cancelled: Wrong Delivery Address | Shipment | |
| FID 63495 - Delivery Delay | /shipment#delivery_delay |
FID 63495 - Delivery Delay | Shipment | |
| FID 63495 - Delivery Location Not Accessible | /shipment#delivery_location_not_accessible |
FID 63495 - Delivery Location Not Accessible | Shipment | |
| Demurrage (Storage) Incurred | /shipment#demurrage_storage_incurred |
Demurrage (Storage) Incurred | Shipment | |
| Discharge Delay at Ocean Port | /shipment#discharge_delay_at_ocean_port |
Discharge Delay at Ocean Port | Shipment | |
| Dry Run: Delivery Attempt Not Completed | /shipment#dry_run_delivery_attempt_not_completed |
Dry Run: Delivery Attempt Not Completed | Shipment | |
| Dry Run: Delivery Location Closed | /shipment#dry_run_delivery_location_closed |
Dry Run: Delivery Location Closed | Shipment | |
| Dry Run: Delivery Refused by Consignee | /shipment#dry_run_delivery_refused_by_consignee |
Dry Run: Delivery Refused by Consignee | Shipment | |
| FID 63495 - Dry Run: Improper Equipment for Delivery | /shipment#dry_run_improper_equipment_for_delivery |
FID 63495 - Dry Run: Improper Equipment for Delivery | Shipment | |
| Dry Run: Pick Up Not Completed | /shipment#dry_run_pickup |
Dry Run: Pick Up Not Completed | Shipment | |
| Early Delivery Expected | /shipment#early_delivery_expected |
Early Delivery Expected | Shipment | |
| EMEA Customs Hold Released | /shipment#emea_customs_hold_released |
EMEA Customs Hold Released | Shipment | |
| EMEA Customs Inspection Released | /shipment#emea_customs_inspection_released |
EMEA Customs Inspection Released | Shipment | |
| Empty Container Not Returned | /shipment#empty_container_not_returned |
Empty Container Not Returned | Shipment | |
| Shipment Under EPA Exam - Hold Cargo Intact | /shipment#epa_exam_hold_intact |
Shipment Under EPA Exam - Hold Cargo Intact | Shipment | |
| EPA May Proceed (Released) | /shipment#epa_may_proceed |
EPA May Proceed (Released) | Shipment | |
| Shipment Under EPA Review - Hold Cargo Intact | /shipment#epa_review_under_review_hold_cargo_intact |
Shipment Under EPA Review - Hold Cargo Intact | Shipment | |
| Equipment Unavailable | /shipment#equipment_unavailable |
Equipment Unavailable | Shipment | |
| EU Other Government Agency (OGA) Hold | /shipment#eu_other_government_agency_oga_hold |
EU Other Government Agency (OGA) Hold | Shipment | |
| Export Country Customs Exam | /shipment#export_country_customs_exam |
Export Country Customs Exam | Shipment | |
| Export Country Magnetism Exam | /shipment#export_country_magnetism_exam |
Export Country Magnetism Exam | Shipment | |
| FID 63495 - Export Customs Cleared | /shipment#export_customs_cleared |
FID 63495 - Export Customs Cleared | Shipment | |
| FID 63495 - Export Customs Requested | /shipment#export_customs_requested |
FID 63495 - Export Customs Requested | Shipment | |
| Shipment Under FDA Hold - Hold Cargo Intact | /shipment#fda_hold_hold_intact |
Shipment Under FDA Hold - Hold Cargo Intact | Shipment | |
| FDA May Proceed (Released) | /shipment#fda_may_proceed |
FDA May Proceed (Released) | Shipment | |
| Shipment Under Standard FDA Review - Hold Cargo Intact (No Action Needed) | /shipment#fda_review_under_review_hold_cargo_intact |
Shipment Under Standard FDA Review - Hold Cargo Intact (No Action Needed) | Shipment | |
| FID 63495 - Delay at unloading | /shipment#fid_63495_delay_at_unloading |
FID 63495 - Delay at unloading | Shipment | |
| FID 63495 - Linehaul arrival late | /shipment#fid_63495_linehaul_arrival_late |
FID 63495 - Linehaul arrival late | Shipment | |
| FID 63495 - Linehaul departure late | /shipment#fid_63495_linehaul_departure_late |
FID 63495 - Linehaul departure late | Shipment | |
| FID 63495 - Pick-up delayed due to late assignment by TMC | /shipment#fid_63495_pick_up_delayed_due_to_late_assignment_by_tmc |
FID 63495 - Pick-up delayed due to late assignment by TMC | Shipment | |
| FID 63495 - Root cause unknown | /shipment#fid_63495_root_cause_unknown |
FID 63495 - Root cause unknown | Shipment | |
| FID 63495 - Technical problems at LSP (at hub / consolidation point) | /shipment#fid_63495_technical_problems_at_lsp_at_hub_consolidation_point_ |
FID 63495 - Technical problems at LSP (at hub / consolidation point) | Shipment | |
| Shipment Under Fish & Wildlife (FWS) Hold - Hold Cargo Intact | /shipment#fish_and_wildlife_hold |
Shipment Under Fish & Wildlife (FWS) Hold - Hold Cargo Intact | Shipment | |
| Fish & Wildlife (FWS) Released | /shipment#fish_and_wildlife_released |
Fish & Wildlife (FWS) Released | Shipment | |
| Flexport Booking Error | /shipment#flexport_booking_error |
Flexport Booking Error | Shipment | |
| Flexport Documentation Error | /shipment#flexport_documentation_error |
Flexport Documentation Error | Shipment | |
| Flight Delay: Mechanical Problem | /shipment#flight_delay_mechanical |
Flight Delay: Mechanical Problem | Shipment | |
| Flight Delay: Schedule Updated by Carrier | /shipment#flight_delay_schedule_updated_by_carrier |
Flight Delay: Schedule Updated by Carrier | Shipment | |
| Goods Damaged | /shipment#goods_damaged |
Goods Damaged | Shipment | |
| FID 63495 - Goods Damaged at Service Center | /shipment#goods_damaged_at_service_center |
FID 63495 - Goods Damaged at Service Center | Shipment | |
| FID 63495 - Goods Damaged in Transit | /shipment#goods_damaged_in_transit |
FID 63495 - Goods Damaged in Transit | Shipment | |
| FID 63495 - Goods Lost in Transit | /shipment#goods_lost_in_transit |
FID 63495 - Goods Lost in Transit | Shipment | |
| FID 63495 - Goods Missing in Transit | /shipment#goods_missing_in_transit |
FID 63495 - Goods Missing in Transit | Shipment | |
| US Customs Hold | /shipment#hold_cbp |
US Customs Hold | Shipment | |
| Incomplete Shipper Onboarding | /shipment#incomplete_shipper_onboarding |
Incomplete Shipper Onboarding | Shipment | |
| ISF Not on File | /shipment#isf_not_on_file |
ISF Not on File | Shipment | |
| [DO NOT USE]Late House Bill of Lading Release | /shipment#late_bill_of_lading_release |
[DO NOT USE]Late House Bill of Lading Release | Shipment | |
| LSP Prealert Issue | /shipment#lsp_prealert_issue |
LSP Prealert Issue | Shipment | |
| US Customs Manifest Hold | /shipment#manifest_hold_cbp |
US Customs Manifest Hold | Shipment | |
| Missed Appointment | /shipment#missed_appointment |
Missed Appointment | Shipment | |
| Missing Cargo at Final Destination | /shipment#missing_cargo |
Missing Cargo at Final Destination | Shipment | |
| Missing Consignee Commercial Invoice/Packing List | /shipment#missing_consignee_commercial_invoice_packing_list |
Missing Consignee Commercial Invoice/Packing List | Shipment | |
| Missing Customs Documents | /shipment#missing_customs_documents |
Missing Customs Documents | Shipment | |
| Missing Dangerous Goods (DG) Document | /shipment#missing_dangerous_goods_dg_document |
Missing Dangerous Goods (DG) Document | Shipment | |
| Missing Proof of Delivery (POD) | /shipment#missing_proof_of_delivery_pod_ |
Missing Proof of Delivery (POD) | Shipment | |
| Name of Consignee Unclear | /shipment#name_of_consignee_unclear |
Name of Consignee Unclear | Shipment | |
| No Delivery Appointments Available | /shipment#no_appointments_available |
No Delivery Appointments Available | Shipment | |
| No Attempt Made | /shipment#no_attempt_made |
No Attempt Made | Shipment | |
| Ocean Port Dwell Delay | /shipment#ocean_port_dwell_delay |
Ocean Port Dwell Delay | Shipment | |
| FID 63495 - On Hand at Destination Service Center | /shipment#on_hand_at_destination_service_center |
FID 63495 - On Hand at Destination Service Center | Shipment | |
| FID 63495 - On Hand at Hub/Consolidation Center Destination | /shipment#on_hand_at_hub_consolidation_center_destination |
FID 63495 - On Hand at Hub/Consolidation Center Destination | Shipment | |
| FID 63495 - On Hand at Hub/Consolidation Center Origin | /shipment#on_hand_at_hub_consolidation_center_origin |
FID 63495 - On Hand at Hub/Consolidation Center Origin | Shipment | |
| FID 63495 - On Hand at Origin Service Center | /shipment#on_hand_at_origin_service_center |
FID 63495 - On Hand at Origin Service Center | Shipment | |
| Other Customs Exception | /shipment#other_customs_exception |
Other Customs Exception | Shipment | |
| Packaging Issue | /shipment#packaging_issue |
Packaging Issue | Shipment | |
| Passed OGA Exam | /shipment#passed_oga_exam |
Passed OGA exam | Shipment | |
| Pending Customs Clearance from Nominated Broker | /shipment#pending_customs_clearance_from_nominated_broker |
Pending Customs Clearance from Nominated Broker | Shipment | |
| Pending Delivery Appointment Confirmation | /shipment#pending_delivery_appointment_confirmation |
Pending Delivery Appointment Confirmation | Shipment | |
| FID 63495 - Pickup Cancelled: Cargo Damaged | /shipment#pickup_cancelled_cargo_damaged |
FID 63495 - Pickup Cancelled: Cargo Damaged | Shipment | |
| FID 63495 - Pickup Cancelled: No Pickup Possible | /shipment#pickup_cancelled_no_pickup_possible |
FID 63495 - Pickup Cancelled: No Pickup Possible | Shipment | |
| FID 63495 - Pickup Cancelled: Wrong Pickup Address | /shipment#pickup_cancelled_wrong_pickup_address |
FID 63495 - Pickup Cancelled: Wrong Pickup Address | Shipment | |
| FID 63495 - Pickup Delay | /shipment#pickup_delayed |
FID 63495 - Pickup Delay | Shipment | |
| Port Strike Delay | /shipment#port_strike_delay |
Port Strike Delay | Shipment | |
| Railcar Equipment Breakdown | /shipment#rail_car_equipment_breakdown |
Railcar Equipment Breakdown | Shipment | |
| Rail Delay: Schedule Updated by Carrier | /shipment#rail_delay_schedule_updated_by_carrier |
Rail Delay: Schedule Updated by Carrier | Shipment | |
| Rail Interchange Delay | /shipment#rail_interchange_delay |
Rail Interchange Delay | Shipment | |
| Rail Transfer Delay | /shipment#rail_transfer_delay |
Rail Transfer Delay | Shipment | |
| FID 63495 - Cargo Returned to Shipper | /shipment#returned_to_shipper |
FID 63495 - Cargo Returned to Shipper | Shipment | |
| FID 63495 - Security Delay | /shipment#security_delay |
FID 63495 - Security Delay | Shipment | |
| FID 63495 - Shipment Booked with Carrier | /shipment#shipment_booked_with_carrier |
FID 63495 - Shipment Booked with Carrier | Shipment | |
| Shipment Cancellation Requested | /shipment#shipment_cancellation_requested |
Shipment Cancellation Requested | Shipment | |
| FID 63495 - Shipment Cancellation Requested: Post Pickup | /shipment#shipment_cancellation_requested_post_pickup |
FID 63495 - Shipment Cancellation Requested: Post Pickup | Shipment | |
| FID 63495 - Shipment Cancellation Requested: Pre Pickup | /shipment#shipment_cancellation_requested_pre_pickup |
FID 63495 - Shipment Cancellation Requested: Pre Pickup | Shipment | |
| FID 63495 - Shipment Delay: Force Majeure | /shipment#shipment_delay_force_majeure |
FID 63495 - Shipment Delay: Force Majeure | Shipment | |
| FID 63495 - Shipment Delay: Holiday | /shipment#shipment_delay_holiday |
FID 63495 - Shipment Delay: Holiday | Shipment | |
| FID 63495 - Shipment Delay: In Clarification | /shipment#shipment_delay_in_clarification |
FID 63495 - Shipment Delay: In Clarification | Shipment | |
| FID 63495 - Shipment Delay: Other Reasons | /shipment#shipment_delay_other_reasons |
FID 63495 - Shipment Delay: Other Reasons | Shipment | |
| FID 63495 - Shipment On Time | /shipment#shipment_on_time |
FID 63495 - Shipment On Time | Shipment | |
| Shipment Re-Routed by Carrier | /shipment#shipment_rerouted_by_carrier |
Shipment Re-Routed by Carrier | Shipment | |
| Shipment Re-Routed per Client Request | /shipment#shipment_rerouted_per_client_request |
Shipment Re-Routed per Client Request | Shipment | |
| [Ocean Planning]Carrier-Initiated Change Of Vessel / Shipment Roll | /shipment#shipment_rolled_by_carrier |
[Ocean Planning]Carrier-Initiated Change Of Vessel / Shipment Roll | Shipment | |
| Shipment Split | /shipment#shipment_split |
Shipment Split | Shipment | |
| Shortage/Overage of Cargo Received at Origin CFS | /shipment#shortage_overage_of_cargo_received_at_origin_cfs |
Shortage/Overage of Cargo Received at Origin CFS | Shipment | |
| SLA Error/SLA Alignment | /shipment#sla_error_sla_alignment |
SLA Error/SLA Alignment | Shipment | |
| FID 63495 - Sorting Error | /shipment#sorting_error |
FID 63495 - Sorting Error | Shipment | |
| Export Special Handling Request | /shipment#special_handling_request |
Export Special Handling Request | Shipment | |
| Shipper Late Documents | /shipment#supplier_late_documents |
Shipper Late Documents | Shipment | |
| Supplier Late Gate-In | /shipment#supplier_late_gate_in |
Supplier Late Gate-In | Shipment | |
| FID 63495 - Tendered To Carrier | /shipment#tendered_to_carrier |
FID 63495 - Tendered To Carrier | Shipment | |
| Terminal Departure Delay: Other | /shipment#terminal_departure_delay_other |
Terminal Departure Delay: Other | Shipment | |
| Transload Delay | /shipment#transload_delay |
Transload Delay | Shipment | |
| Transshipment Delay | /shipment#transshipment_delay |
Transshipment Delay | Shipment | |
| Trucker Rejected | /shipment#trucker_rejected |
Trucker Rejected | Shipment | |
| Trucker's Hours Expired | /shipment#truckers_hours_expired |
Trucker's Hours Expired | Shipment | |
| Trucking Delay: Chassis Problem | /shipment#trucking_delay_chassis_problem |
Trucking Delay: Chassis Problem | Shipment | |
| Trucking Delay: Mechanical Problem | /shipment#trucking_delay_mechanical_problem |
Trucking Delay: Mechanical Problem | Shipment | |
| Trucking Delay: Other | /shipment#trucking_delay_other |
Trucking Delay: Other | Shipment | |
| Port congestion. Shipment has been delayed | /shipment#trucking_delay_port_congestion |
Port congestion. Shipment has been delayed | Shipment | |
| Trucking Delay: Strike | /shipment#trucking_delay_strike |
Trucking Delay: Strike | Shipment | |
| Trucking Delay: Traffic | /shipment#trucking_delay_traffic |
Trucking Delay: Traffic | Shipment | |
| Unclear/Mismatched Consignee Commercial Invoice/Packing List | /shipment#unclear_mismatched_consignee_commercial_invoice_packing_list |
Unclear/Mismatched Consignee Commercial Invoice/Packing List | Shipment | |
| Undergoing CPSC | /shipment#undergoing-cpsc |
Undergoing CPSC | Shipment | |
| Undergoing FDA Exam | /shipment#undergoing-fda-exam |
Undergoing FDA Exam | Shipment | |
| Undergoing USDA | /shipment#undergoing-usda |
Undergoing USDA | Shipment | |
| Undergoing OGA Exam | /shipment#undergoing_oga_exam |
Undergoing OGA exam | Shipment | |
| Unexpected Flight Cancellation by the Carrier | /shipment#unexpected_flight_cancellation_by_the_carrier |
Unexpected Flight Cancellation by the Carrier | Shipment | |
| Unknown Customs Hold Type | /shipment#unknown_customs_hold_type |
Unknown Customs Hold Type | Shipment | |
| Vessel Delay: Mechanical Problem | /shipment#vessel_delay_mechanical |
Vessel Delay: Mechanical Problem | Shipment | |
| Vessel Delay: Port Congestion | /shipment#vessel_delay_port_congestion |
Vessel Delay: Port Congestion | Shipment | |
| Vessel Delay: Ocean Transit Schedule Updated by Carrier | /shipment#vessel_delay_schedule_updated_by_carrier |
Vessel Delay: Ocean Transit Schedule Updated by Carrier | Shipment | |
| Warehouse Devan Delay | /shipment#warehouse_devan_delay |
Warehouse Devan Delay | Shipment | |
| Warehouse: Other | /shipment#warehouse_other |
Warehouse: Other | Shipment | |
| Weather delay | /shipment#weather_delay |
Weather delay | Shipment |
For all Invoice Events, the data field of the Event webhook payload is an Invoice Event Data object. There is no direct access from the payload to shipment, location, or container information like there is in a Shipment Event Data object.
| Name | Type | Description |
|---|---|---|
| Invoice Payment Made | /invoice#invoice_payment_made |
Invoice payment has been made |
| Invoice Due Date Adjusted | /invoice#invoice_due_date_adjusted |
Invoice payment due date has been adjusted |
| Invoice Shared | /invoice#invoice_shared |
Invoice has been shared |
| Invoice Voided | /invoice#invoice_voided |
Invoice has been voided |
| Invoice Credit Applied | /invoice#invoice_credit_applied |
Invoice credit has been applied |
| Invoice Refund Applied | /invoice#invoice_refund_applied |
Invoice refund has been applied |
| Invoice Payment Failed | /invoice#invoice_payment_failed |
Invoice payment failed |
For all Document Events, the data field of the Document webhook payload is a Document Event Data object. Depending on what the document is connected to, the payload may or may not contain shipment information.
| Name | Type | Description |
|---|---|---|
| Document Created* | /document#document_created |
A document has been created |
For all PurchaseOrder Events, the data field of the Event webhook payload is a PurchaseOrder Event Data object. It contains PurchaseOrder header-level information, as well as context that is unique to each event.
| Name | Type | Description |
|---|---|---|
| PurchaseOrder Acknowledged | /purchase_order#acknowledged |
PurchaseOrder has been acknowledged |
| PurchaseOrder Updated | /purchase_order#updated |
PurchaseOrder has been updated, currently only supports update through order collaboration flow |