Hfd icon

Hfd

Consume Hfd API (v.0.1.1)

Actions4

Shipments → Create

AI-generated

Overview

This node integrates with the Hfd API to create shipment records. It is designed for logistics, shipping companies, or e-commerce platforms that need to automate the creation of shipments in the Hfd system. By using this node, users can programmatically submit detailed shipment information such as sender and recipient details, cargo types, and payment instructions.

Practical examples include:

  • Automatically creating a shipment when an order is placed on an e-commerce site.
  • Integrating with warehouse management systems to schedule pickups and deliveries.
  • Automating bulk shipment creation from CSV or database inputs.

Properties

Name Meaning
Client Number Numeric identifier for the client initiating the shipment.
Mesira Isuf A required string field, likely representing a specific shipment or client code.
Shipment Type Code Numeric code indicating the type/category of the shipment.
Orderer Name Name of the person or entity placing the order/shipment.
Cargo Type Haloch Numeric code specifying the cargo type under "Haloch" classification.
Name To Recipient's name for the shipment.
City Name Destination city name.
Street Name Destination street name.
House Num House number at the destination address.
Tel First Primary telephone contact number for the shipment.
Email Contact email address related to the shipment.
Additional Fields Collection of optional fields to provide extra shipment details:
- Stage Code Numeric code representing the shipment stage.
- Cargo Type Hazor Numeric code for another cargo classification ("Hazor").
- Packs Haloch String describing packaging under "Haloch".
- Packs Hazor Numeric count of packages under "Hazor".
- Passport Num Passport number associated with the shipment (likely for customs or identification).
- City Code Code representing the city.
- Street Code Code representing the street.
- Entrance Entrance details for delivery location.
- Floor Floor number for delivery location.
- Apartment Apartment number for delivery location.
- Tel Second Secondary telephone contact number.
- Address Remarks Additional remarks about the address.
- Shipment Remarks Additional remarks about the shipment itself.
- Reference Num1 First reference number for tracking or internal use.
- Reference Num2 Second reference number for tracking or internal use.
- Future Date Scheduled future date for shipment handling.
- Future Time Scheduled future time for shipment handling.
- Pudo Code Origin Numeric code for pickup/dropoff origin location.
- Pudo Code Destination Numeric code for pickup/dropoff destination location.
- Auto Bind Pudo String flag or code to auto-bind pickup/dropoff points.
- Products Price Numeric total price of products in the shipment.
- Product Price Currency Currency code for the product price.
- Shipment Weight Numeric weight of the shipment.
- Zip Code Postal code for the destination address.
- Order Items List of items included in the shipment, each with:
- Code Item code identifier.
- Quantity Quantity of the item.
- Govina Payment collection details if courier collects payment from consignee:
- Code Payment type code.
- Sum Amount to be collected.
- Date Date of payment collection.
- Remarks Notes regarding the payment collection.

Output

The node outputs JSON data representing the response from the Hfd API after attempting to create the shipment. This typically includes confirmation details such as shipment ID, status, and any messages returned by the API.

If the API supports binary data output (e.g., labels or documents), it would be included accordingly, but based on the provided code and properties, the primary output is structured JSON data reflecting the created shipment record.

Dependencies

  • Requires an API key credential for authenticating with the Hfd API.
  • Uses an HTTP client internally to communicate with the Hfd backend service.
  • The node depends on the Hfd API being accessible and properly configured with valid credentials.
  • No other external services are explicitly required.

Troubleshooting

  • Authentication errors: If the API key or authentication token is invalid or missing, the node will fail to connect. Ensure the API credentials are correctly set up in n8n.
  • Validation errors: Missing required fields like Client Number, Mesira Isuf, or Shipment Type Code will cause the API to reject the request. Double-check all mandatory properties are provided.
  • Incorrect codes: Using invalid numeric codes for shipment type, cargo type, or payment types may result in API errors. Verify these codes against Hfd documentation.
  • Network issues: Connectivity problems to the Hfd API endpoint will cause execution failures. Check network access and firewall settings.
  • Date/time formatting: Future Date and Future Time fields must be in the expected format; otherwise, the API might reject them.
  • Large payloads: Sending very large order items or additional fields might exceed API limits; consider batching requests if needed.

Links and References

Discussion