Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Consignment Header → Get One Consignment Header

AI-generated

Overview

This node interacts with the Halo PSA API to retrieve data related to consignment headers. Specifically, the "Get One Consignment Header" operation fetches detailed information about a single consignment header identified by its unique ID. This is useful in scenarios where you need to access or verify specific shipment or consignment details within your service management or logistics workflows.

Practical examples include:

  • Fetching consignment header details to display shipment status in a dashboard.
  • Integrating consignment data into an ERP or CRM system for order tracking.
  • Automating notifications based on consignment information retrieved from Halo PSA.

Properties

Name Meaning
Id The unique identifier (number) of the consignment header to retrieve.
Includedetails Optional flag/query parameter to specify whether to include detailed information in the response.

Output

The node outputs JSON data representing the consignment header object as returned by the Halo PSA API. This includes all standard fields of the consignment header and, if requested, additional detailed information.

If the Includedetails property is set, the output will contain extended details related to the consignment header.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant identifier, client ID, and client secret.
  • The node uses these credentials to authenticate requests via HTTP headers.
  • No other external dependencies are required.

Troubleshooting

  • Missing Credentials Error: If no credentials are provided or they are invalid, the node will throw an error indicating "No credentials returned!". Ensure that the API key credential is properly configured in n8n.
  • Resource or Operation Not Found: Errors like "Resource Consignment Header not found" or "Operation Get One Consignment Header not found for resource Consignment Header" indicate misconfiguration of the resource or operation names.
  • Invalid ID Parameter: Providing an invalid or missing Id value may cause the API request to fail or return no data.
  • API Request Failures: Network issues, incorrect base URL, or authentication failures will result in errors during the HTTP request. Verify connectivity and credential correctness.
  • JSON Parsing Issues: If additional query parameters or request bodies are malformed JSON, parsing errors may occur.

To resolve most issues, verify input parameters, ensure credentials are correct, and check network connectivity to the Halo PSA API endpoint.

Links and References

Discussion