Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Consignment Header → Post Undefined

AI-generated

Overview

This node integrates with the Halo PSA API to perform operations on various resources, specifically here focusing on the Consignment Header resource with a "Post Undefined" operation. Essentially, it allows users to send POST requests to create or update consignment header data in Halo PSA by submitting structured JSON bodies.

Typical use cases include:

  • Automating the creation of consignments with detailed line items and associated assets.
  • Integrating external systems to push consignment data into Halo PSA for inventory or asset management.
  • Bulk uploading or updating consignment headers with complex nested data structures.

For example, a user might prepare a JSON body describing multiple consignment lines, each with serialized assets and custom fields, then post this data to Halo PSA to register new consignments programmatically.

Properties

Name Meaning
Body A JSON object representing the consignment header details to be posted. This includes nested arrays such as lines (each containing serialised_assets, customfields, custombuttons, and allowed_status) and assets. The structure supports complex configurations like visibility conditions, validation reasons, and database lookup triggers within these nested objects.

The property expects a JSON input that matches the schema used by Halo PSA for consignment headers. Users can customize this JSON to fit their specific consignment data needs.

Output

The node outputs an array of JSON objects corresponding to the response from the Halo PSA API for each input item processed. Each output item contains:

  • json: The parsed JSON response returned by the Halo PSA API after posting the consignment header data. This typically includes confirmation details, created resource identifiers, or error messages if the request failed.

No binary data output is indicated for this operation.

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant identifier, client ID, and client secret.
  • The node depends on network connectivity to the Halo PSA service endpoint.
  • No additional external services are required beyond the Halo PSA API itself.

Troubleshooting

  • No credentials returned!: This error occurs if the node cannot retrieve the necessary API authentication credentials. Ensure that the API key credential is properly configured in n8n.
  • Resource or Operation not found: If the specified resource or operation does not exist, verify that the resource name is exactly "Consignment Header" and the operation is correctly set to "Post Undefined".
  • JSON parsing errors: Since the body property expects valid JSON, malformed JSON input will cause failures. Validate your JSON before running the node.
  • API request failures: Network issues, invalid credentials, or incorrect request body structure may cause the Halo PSA API to reject the request. Check the error message returned in the output JSON for clues.
  • To handle errors gracefully, enable the "Continue On Fail" option in the node settings to process subsequent items even if some fail.

Links and References

  • Halo PSA API Documentation — Official API docs for understanding the expected request and response formats.
  • n8n Documentation — For general guidance on using credentials and configuring HTTP request nodes.
  • JSON validators such as JSONLint can help ensure your input body is well-formed.

Discussion