HostBill icon

HostBill

Consume HostBill API (v.0.1.3)

Overview

The HostBill node for n8n allows users to interact with the HostBill API, specifically to retrieve a list of orders. The "Order: Get All" operation fetches multiple orders from your HostBill system, supporting filtering and pagination. This is useful for automating order management workflows, synchronizing order data with other systems, or generating reports.

Practical examples:

  • Retrieve all active orders to process them in another system.
  • List pending orders for follow-up actions.
  • Paginate through large sets of orders for batch processing.

Properties

Name Type Meaning
Additional Fields Collection A group of optional parameters to refine the query.
Page Number (Within Additional Fields) Specifies which page of results to return. Default is 1.
Status or Orders to List Options (Within Additional Fields) Filter orders by status: All, Active, Pending, Fraud, Cancelled.

Output

The node outputs an array of JSON objects, each representing an order retrieved from HostBill. The exact structure of each order object depends on the HostBill API response, but typically includes fields such as order ID, status, customer information, and order details.

Example output:

[
  {
    "id": 123,
    "status": "active",
    "customer": "John Doe",
    "total": 99.99,
    // ...other order fields
  },
  ...
]

Note: The actual fields may vary based on your HostBill configuration.

Dependencies

  • External Service: Requires access to a HostBill instance with API enabled.
  • API Credentials: You must configure hostBillApi credentials in n8n.
  • n8n Configuration: No special environment variables are required beyond standard credential setup.

Troubleshooting

  • Invalid Credentials: If the API credentials are incorrect or missing, the node will throw an authentication error. Ensure that the hostBillApi credentials are set up correctly in n8n.
  • API Connection Issues: Network problems or incorrect HostBill API URLs can cause connection errors.
  • Permission Errors: The API user must have permission to list orders; otherwise, you may receive authorization errors.
  • Error Handling: If an error occurs during execution and "Continue On Fail" is enabled, the node will output an object with an error field containing the error message.

Links and References

Discussion