Hfd icon

Hfd

Consume Hfd API (v.0.1.1)

Shipments → Get Tracking Information

AI-generated

Overview

This node integrates with the Hfd API to retrieve shipment tracking information. It is designed to query shipment status by either a shipment number or a combination of identification letters and reference number provided by the shipping company. This node is useful in logistics, e-commerce, or any workflow requiring real-time shipment tracking updates.

Typical use cases include:

  • Automatically fetching the current status of a shipment to update order management systems.
  • Triggering notifications or alerts based on shipment progress.
  • Integrating shipment tracking into customer service dashboards.

Properties

Name Meaning
APPNAME Hidden property set to "run", likely used internally for API request context.
PRGNAME Hidden property set to "ship_status_xml", probably specifying the program or endpoint name in the API call.
P1 Shipment number returned from a previous web service call. Use this if available; leave P2 blank if using P1.
P2 Combination of your identification letters at the shipping company plus your reference number. Use this if P1 is not used.

Output

The node outputs JSON data containing the shipment tracking information retrieved from the Hfd API. The exact structure depends on the API response but typically includes details such as shipment status, timestamps, location updates, and other relevant tracking metadata.

If binary data were involved (e.g., documents or images), it would be summarized here, but this node appears focused on JSON responses only.

Dependencies

  • Requires an API key credential for authenticating with the Hfd API.
  • Uses an internal HTTP client wrapper to make requests.
  • Depends on the Hfd API being accessible and responsive.
  • No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

  • Empty or missing tracking data: Ensure that either P1 or P2 is correctly provided, but not both simultaneously.
  • Authentication errors: Verify that the API key credential is valid and has the necessary permissions.
  • Network issues: Confirm connectivity to the Hfd API endpoint.
  • Invalid parameters: Double-check the format of P1 and P2 according to the shipping company's requirements.
  • Unexpected API responses: Review the API documentation or contact support if the response structure changes.

Links and References

  • Hfd API Documentation (Link not provided in source, add if available)
  • Shipment tracking best practices in logistics workflows.
  • n8n HTTP Request node documentation for understanding underlying request mechanics.

Discussion