Order → Get Many
AI-generatedOverview
This node interacts with the Xgate API to retrieve multiple orders based on specified filter criteria. It is useful for scenarios where users need to fetch a list of orders filtered by payment date range, payment status, or customer code. For example, a user can retrieve all fully paid orders made by a specific customer within a certain date range.
Use Case Examples
- Fetch all orders paid between two dates.
- Retrieve all unpaid orders for a specific customer.
Properties
| Name | Meaning |
|---|---|
| Options | Collection of optional filters to refine the orders retrieved. |
Output
JSON
orderId- Unique identifier of the order.paymentDate- Timestamp of the order payment.paymentStatus- Status of the order payment (e.g., UNPAID, FULLY_PAID, FULLY_REFUND).customerCode- Code identifying the customer who placed the order.
Dependencies
- Xgate API with an API key credential for authentication
Troubleshooting
- Ensure the API credentials are correctly configured to avoid authentication errors.
- Date filters must be valid date-time strings; invalid dates may cause request failures.
- If no orders match the filters, the output will be an empty array, which is expected behavior.