Houzz

Consume the Houzz API common functionality

Overview

The Houzz Order: Get All operation node retrieves a list of orders from the Houzz API. It allows users to fetch all or a limited number of order records, with optional filtering based on various conditions such as date ranges or specific field values. This node is useful for automating workflows that require access to order data, such as synchronizing orders with other systems, generating reports, or triggering actions based on new or updated orders.

Practical examples:

Fetching all recent orders to update an inventory management system.
Retrieving orders placed within the last 7 days for analytics.
Filtering orders by specific criteria (e.g., status, customer ID).

Properties

Name	Type	Meaning
Return All	Boolean	Whether to return all results or only up to a specified limit.
Limit	Number	The maximum number of results to return (only shown if "Return All" is false; min: 1, max: 10).
Options	Collection	Additional options for the request, including filters.
└─ Filter	FixedCollection	Allows adding multiple filter conditions to narrow down the results.
└─ Field	Options	The field to filter by (options loaded dynamically, e.g., order status, date, etc.).
└─ Condition Type	Options	The type of condition to apply (e.g., Equals).
└─ Value	String	The value to compare against (not required for some special fields like date ranges).

Output

The node outputs an array of order objects in the json field. Each object represents an order returned by the Houzz API. The structure of each order object depends on the API response but typically includes fields such as:

{
  "OrderId": "...",
  "CustomerName": "...",
  "OrderDate": "...",
  // ...other order-specific fields
}

If an error occurs and "Continue On Fail" is enabled, the output may include objects with an error property containing the error message.

Dependencies

External Service: Requires access to the Houzz API.
Credentials: Needs a configured houzzApi credential in n8n.
Environment: No additional environment variables are required beyond standard n8n setup.

Troubleshooting

Common issues:

Invalid credentials: If the houzzApi credential is missing or incorrect, authentication errors will occur.
API limits: The "Limit" property enforces a maximum of 10 results per request when not returning all.
Filter misconfiguration: Using unsupported fields or invalid values in filters may result in empty responses or API errors.
Date range filters: Special fields like "Today", "Yesterday", or "7Days" automatically set date ranges; ensure these are used correctly.

Error messages:

"error": "Some error message": Indicates an issue occurred during execution. Check the error message for details (e.g., authentication failure, invalid parameters).
If the node stops without output, check logs for debug information about the query parameters (qs) and filters.