Everest icon

Everest

Interact with Everest TMS (Transport Management System)

Overview

The node integrates with Everest TMS (Transport Management System) to perform various operations on different resources. Specifically, for the Contact resource with the Get Many operation, it retrieves multiple contact records from the system. This is useful when you want to fetch a list of contacts, optionally filtered by search terms and paginated.

Typical use cases include:

  • Synchronizing contact lists from Everest TMS into another system.
  • Displaying or processing batches of contacts for reporting or automation workflows.
  • Searching contacts by name or other criteria within an automated workflow.

Properties

Name Meaning
Options Collection of optional parameters to control the query:
- Limit Maximum number of contact results to return (default 50).
- Limit Start Starting offset for pagination, zero-based index (default 0).
- Search Search term string to filter contacts by matching relevant fields (e.g., name, email).

Output

The output is a JSON array where each element represents a contact object retrieved from Everest TMS. Each contact object contains the data fields as defined by the Everest API for contacts (such as name, email, phone, etc.). The exact structure depends on the API response but typically includes identifying and descriptive information about each contact.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Everest TMS API.
  • The node internally calls a helper function to make authenticated POST requests to the Everest API endpoints.
  • No additional external dependencies beyond the configured Everest API credentials are needed.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing invalid values for pagination (e.g., negative limit or offset) may result in errors or empty responses.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • Authentication errors usually indicate invalid or expired API keys; verify and update credentials.
    • Rate limiting or quota exceeded errors require checking Everest TMS API usage limits.
    • If the node returns an error message wrapped in the output (when "Continue On Fail" is enabled), inspect the message for details such as invalid parameters or server errors.

Links and References

  • Everest TMS official API documentation (refer to your Everest TMS provider for exact URLs).
  • n8n documentation on creating and using custom nodes and credentials.

Discussion