Required api role: API_TRIP
Purpose: This interface allows an external system (e.g. a route optimisation tool) to send fully planned trips into Qargo.
When a trip payload arrives, Qargo creates or updates a trip with the specified stops, sequence, timestamps, and resource assignments — without manual planning.
The trip import is the last step of a larger planning flow:
- The external system obtains the Qargo
ids of the stops and resources to plan. Qargo can push this planning data to the external system (an optional export, configured per integration), or the external system fetches it via the API (e.g. orders and resources). - The external system computes trips and assigns each one a
trip_identifier. - The external system pushes the planned trips to the trip import webhook.
A trip import pushes stop sequences, resource assignments, and timing information into Qargo so that the planning board reflects the externally computed plan.
The trip_identifier is used to determine whether an incoming trip is new or an update to an existing one:
- Create — a new trip is created when a payload arrives with a
trip_identifierthat has not been seen before. - Update — if a payload arrives with a
trip_identifierthat already exists, Qargo updates the original trip rather than creating a new one. - Cancel — setting
status = 'CANCELLED'will remove the trip. A trip must have been created before it can be cancelled.