Billwerk icon

Billwerk

Automate your subscription business with billwerk

Actions27

Overview

This node interacts with the Billwerk API to automate subscription business processes. Specifically, for the Order resource and the Decline operation, the node allows users to decline (reject) an order by providing its Order ID. This is useful in scenarios where an order needs to be programmatically cancelled or marked as not accepted, such as when a customer cancels before fulfillment or if the order does not meet certain criteria.

Practical Example:
A company receives orders via Billwerk and wants to automatically decline orders that fail a credit check or are flagged by fraud detection systems. By integrating this node into their n8n workflow, they can automate the process of declining such orders.

Properties

Name Type Meaning
Order ID String The unique identifier of the order you wish to decline. Required to specify the target order.

Output

The output will be a JSON object (or array of objects if multiple items are processed). The structure typically includes details about the declined order, such as its status after the operation. If an error occurs and "Continue On Fail" is enabled, the output will include an error field with the error message.

Example output:

[
  {
    "id": "order_12345",
    "status": "declined",
    "message": "Order has been successfully declined."
  }
]

If an error occurs:

[
  {
    "error": "Order not found"
  }
]

Note: The exact fields depend on the Billwerk API response.

Dependencies

  • External Service: Requires access to the Billwerk API.
  • API Key/Credentials: You must configure the billwerkApi credentials in n8n.
  • n8n Configuration: No additional configuration required beyond setting up credentials.

Troubleshooting

  • Common Issues:

    • Invalid Order ID: If the provided Order ID does not exist, the node will return an error message such as "Order not found".
    • Missing Credentials: If the Billwerk API credentials are not set up, the node will fail to authenticate.
    • Insufficient Permissions: The API key used may lack permission to decline orders, resulting in authorization errors.
  • Error Handling:

    • If "Continue On Fail" is enabled, errors for individual items will be returned in the output under the error field.
    • If not enabled, the workflow will stop at the first encountered error.

Links and References

Discussion