Overview
This node integrates with the Xgate API to retrieve multiple order records based on specified filters. It is particularly useful for workflows that need to fetch batches of orders for processing, reporting, or synchronization purposes.
For example, you can use this node to:
- Retrieve all orders paid within a specific date range.
- Filter orders by their payment status such as unpaid, fully paid, or refunded.
- Automate order data extraction for further analysis or integration with other systems.
Properties
| Name | Meaning |
|---|---|
| Options | A collection of optional filters to refine the list of orders retrieved: |
| - Payment At Min: Show orders with payment date at or after this date (date-time). | |
| - Payment At Max: Show orders with payment date at or before this date (date-time). | |
| - Status: Filter orders by payment status. Possible values: Unpaid, Paid, Refunded. |
Output
The node outputs an array of JSON objects representing orders matching the specified criteria. Each object contains order details as returned by the Xgate API.
If any error occurs during execution and "Continue On Fail" is enabled, the output will include an object with an error field describing the issue for the corresponding input item.
No binary data is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the Xgate API.
- The node depends on the external Xgate service being accessible and responsive.
- No additional environment variables are indicated.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Incorrect date formats in the filter options may lead to unexpected results or errors.
- Network connectivity problems can prevent successful API calls.
Error messages:
- Errors from the API are captured and returned in the output if "Continue On Fail" is enabled.
- Typical error messages might relate to invalid parameters or authorization failures.
Resolution tips:
- Verify that the API key credential is correctly configured and has necessary permissions.
- Ensure date inputs follow the expected format and represent valid dates.
- Check network connectivity and API endpoint availability.
Links and References
- Xgate API Documentation (Replace with actual URL if available)