Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Consignment Header → List Of Consignment Header

AI-generated

Overview

This node integrates with the Halo PSA API to list consignment headers. It allows users to retrieve a paginated and optionally filtered or ordered list of consignment header records from the Halo PSA system. This is useful in scenarios where you want to automate workflows involving shipment tracking, logistics management, or inventory control by fetching consignment data directly into n8n.

Practical examples include:

  • Automatically retrieving recent consignments for reporting or dashboard updates.
  • Filtering consignments by specific criteria using ordering and pagination parameters.
  • Integrating consignment data with other systems such as ERP or CRM platforms.

Properties

Name Meaning
Count Number of consignment headers to retrieve (limit).
Idonly Whether to return only IDs of consignment headers (likely a boolean or flag).
Order Primary field name to order the results by (string).
Order 2 Secondary field name to order the results by (string).
Order 3 Tertiary field name to order the results by (string).
Order 4 Fourth-level field name to order the results by (string).
Order 5 Fifth-level field name to order the results by (string).
Orderdesc Whether to order descending on the primary order field (boolean or flag).
Orderdesc 2 Whether to order descending on the secondary order field (boolean or flag).
Orderdesc 3 Whether to order descending on the tertiary order field (boolean or flag).
Orderdesc 4 Whether to order descending on the fourth order field (boolean or flag).
Orderdesc 5 Whether to order descending on the fifth order field (boolean or flag).
Page No The page number to retrieve (for pagination).
Page Size Number of items per page (page size for pagination).
Pageinate Likely a flag to enable or disable pagination (boolean or similar).

Note: The exact types are not explicitly defined but inferred from usage as query parameters.

Output

The node outputs an array of JSON objects representing consignment headers retrieved from the Halo PSA API. Each item corresponds to one consignment header record or, if idonly is set, likely just the ID fields.

The output structure depends on the API response but generally includes all relevant consignment header fields as returned by the Halo PSA endpoint.

No binary data output is indicated for this operation.

Dependencies

  • Requires connection credentials to the Halo PSA API, including:

    • Base URL of the Halo PSA instance.
    • Tenant identifier.
    • Client ID.
    • Client Secret.

  • These credentials must be configured in n8n prior to using the node.

  • The node uses HTTP requests to communicate with the Halo PSA REST API.

Troubleshooting

  • No credentials returned!
    This error occurs if the required API credentials are missing or not properly configured in n8n. Ensure that the API key credential is set up correctly.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that "Consignment Header" and "List Of Consignment Header" are correctly selected.

  • API request errors
    Network issues, invalid parameters, or authentication failures may cause errors during the API call. Check the credentials, network connectivity, and parameter values.

  • Pagination issues
    Incorrect page numbers or sizes might result in empty responses or errors. Validate pagination inputs.

  • Malformed query parameters
    Since many properties map directly to query parameters, ensure that values are valid and correctly formatted.

Links and References

Discussion