Everest icon

Everest

Interact with Everest TMS (Transport Management System)
Join our community

Actions55

Overview

The node integrates with the Everest Transport Management System (TMS) to manage routes. Specifically, the "Route - Update" operation allows users to modify existing route details such as the assigned agent, vehicle, addresses, routing engine, and mission assignments. This is useful in logistics and delivery scenarios where routes need to be adjusted dynamically due to changes in scheduling, resources, or optimization requirements.

Practical examples include:

  • Updating a route's name or color for better identification.
  • Changing the assigned driver or vehicle for a route.
  • Modifying start and end addresses based on new delivery points.
  • Re-optimizing the route after adding or removing missions.
  • Adjusting route status or splitting routes per day for multi-day planning.

Properties

Name Meaning
Route ID The unique identifier of the route to update (required).
Additional Fields Optional fields to set or update route attributes:
- Name Name of the route (e.g., "Route du matin - Secteur Nord").
- Color Route color in hexadecimal format (e.g., "#FF5733").
- Agent Agent assigned to the route (select from available agents).
- Agent Vehicle ID Specific vehicle ID assigned to the agent for this route.
- Start Address Starting address for the vehicle (e.g., "16 avenue Reille, 75014 Paris").
- End Address Ending address for the vehicle.
- Router Routing engine to use; options are: Auto, Manual, VROOM, OSRM.
- Split Per Day Boolean flag indicating whether to split routes per day for multi-day planning.
- Early Departure Boolean flag to allow early departure.
- Distribute Fairly Boolean flag to distribute tasks fairly among vehicles.
- Status Status to apply to all missions in the route (select from available statuses).
Update Fields Additional update options:
- Mission References Comma-separated list of updated mission references (e.g., "ABC123XXX,DEF456YYY").
- Vehicles Comma-separated list of platform vehicle IDs to assign to the route (e.g., "2,3").
- Optimize Boolean flag indicating whether to re-optimize the route after updates.

Output

The node outputs an array of JSON objects representing the updated route(s) after applying the changes. Each JSON object contains the route data returned by the Everest TMS API, reflecting the current state of the route including any updated fields.

If the node supports binary data output (not indicated here), it would typically represent files or attachments related to the route, but this operation focuses on JSON data only.

Dependencies

  • Requires an active connection to the Everest TMS API via an API key credential configured in n8n.
  • Uses internal methods to load options dynamically for agents, statuses, and other selectable fields.
  • No additional external dependencies beyond the Everest API.

Troubleshooting

  • Common Issues:

    • Invalid or missing Route ID will cause the update to fail.
    • Providing invalid values for fields like color (non-hexadecimal) or addresses may result in API errors.
    • Assigning non-existent agent or vehicle IDs will cause failures.
    • Network or authentication issues with the Everest API can prevent successful updates.

  • Error Messages:

    • "Route not found": Check that the Route ID exists and is correct.
    • "Invalid field value": Verify that all input fields conform to expected formats and allowed values.
    • "Authentication failed": Ensure the API key credential is valid and has necessary permissions.
    • "API request failed": Check network connectivity and API endpoint availability.

Resolving these usually involves verifying input parameters, ensuring credentials are correctly set up, and confirming the existence of referenced entities in the Everest system.

Links and References

Discussion