Actions55
- Client Actions
- General Actions
- Mission Actions
- Agent Actions
- Invoice Actions
- Contact Actions
- Alert Actions
- Walter Actions
- Notification Actions
- Webhook Actions
- Route Actions
- Export Actions
Overview
This node interacts with the Everest Transport Management System (TMS) to retrieve multiple route records based on various filtering and sorting criteria. The "Get Many" operation under the "Route" resource allows users to fetch a list of routes, which can be filtered by agent, service, status, date ranges, and other parameters. This is useful for logistics managers or dispatchers who want to monitor ongoing or past transport routes, analyze delivery statuses, or generate reports.
Practical examples:
- Fetching all active routes assigned to a specific agent within a given date range.
- Retrieving routes filtered by service type and sorted by start date descending.
- Searching routes by keywords and excluding finished routes to focus on ongoing deliveries.
Properties
| Name | Meaning |
|---|---|
| Options | A collection of optional filters and settings to refine the query results. |
| Limit | Maximum number of route records to return. Defaults to 10. |
| Limit Start | Starting offset for pagination (0-based index). Useful for paginating through large result sets. |
| Agent | Filter routes by a specific agent. The list of agents is dynamically loaded from the system. |
| Service | Filter routes by a specific service type. The list of services is dynamically loaded from the system. |
| Search | A search term to filter routes by matching relevant fields. |
| Hide Finished Routes | Boolean flag to exclude finished routes and only return ongoing ones. |
| Statuses | Comma-separated list of status slugs to filter routes by specific statuses (e.g., "delivery-ok,pickup,cancelled"). |
| Start Date From | Filter routes with a start date/time from this value (Europe/Paris timezone). |
| Start Date To | Filter routes with a start date/time up to this value (Europe/Paris timezone). |
| Order By | Field to order the results by. Options include: Date Created, Date Modified, Last Status Date, Start Date, Distance, Duration. |
| Order Direction | Direction to order the results: Ascending or Descending. Defaults to Descending. |
Output
The node outputs an array of JSON objects representing the routes that match the specified filters. Each object contains detailed information about a route, such as identifiers, associated agent and service, status, dates, distance, duration, and other relevant metadata.
If binary data were involved (e.g., attachments or files), it would be summarized here, but this operation focuses on JSON data output only.
Dependencies
- Requires an API key credential for authenticating with the Everest TMS API.
- The node uses internal methods to dynamically load options for agents and services via API calls.
- The node expects the environment to have network access to the Everest TMS endpoints.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Providing invalid date formats or out-of-range values in filters may result in errors or empty results.
- Pagination parameters (limit and limit_start) must be numeric and non-negative; otherwise, the API might reject the request.
- Filtering by agent or service requires those entities to exist; if no matching agents/services are found, the result set will be empty.
Error messages:
- Authentication errors typically indicate invalid or expired API keys; reconfigure credentials accordingly.
- Validation errors on input parameters usually specify which field is incorrect; verify property values.
- Network or timeout errors suggest connectivity issues; check network settings and API availability.
Links and References
- Everest TMS official API documentation (not provided here, but recommended to consult for detailed API behavior)
- n8n documentation on creating and using custom nodes
- General REST API best practices for filtering, pagination, and sorting