Actions11
Overview
This node integrates with the IKAS e-commerce platform API to retrieve multiple orders based on specified filters and pagination settings. It is designed to fetch a list of orders, optionally applying various filters such as customer email, order status, or payment status. The node supports automatic pagination to fetch all available orders or manual control over page size and number.
Common scenarios where this node is beneficial include:
- Synchronizing order data from IKAS into another system for reporting or fulfillment.
- Filtering orders by specific criteria (e.g., only confirmed or paid orders) to trigger downstream workflows.
- Fetching large volumes of order data efficiently using automatic pagination.
Practical example:
- A user wants to retrieve all fulfilled orders with payment status "Paid" to generate shipping labels.
- Another use case is fetching orders from a specific customer email to analyze purchase history.
Properties
| Name | Meaning |
|---|---|
| Fetch All Items | Whether to automatically fetch all orders using pagination. If enabled, the node will continue fetching pages until all matching orders are retrieved. |
| Limit | Maximum number of orders to return when not fetching all items automatically. Options: 10, 20, 30, 40, 50. |
| Page | Page number to fetch when not fetching all items automatically. Starts from 1. |
| Page Size | Number of orders to fetch per page when auto-fetching all items. Options: 10, 20, 30, 40, 50. |
| Additional Filters | Collection of optional filters to narrow down the orders returned: |
| - Customer Email | Filter orders by the customer's email address. |
| - Customer ID | Filter orders by the customer's unique identifier. |
| - Order Number | Filter orders by their order number. |
| - Order Status | Filter orders by their status. Multiple selections allowed. Options: Cancelled, Confirmed, Created, Fulfilled, Partially Fulfilled, Refunded. |
| - Order Package Status | Filter orders by package status. Multiple selections allowed. Options include statuses like Cancelled, Delivered, Ready for Shipment, Refunded, Unfulfilled, etc. |
| - Order Payment Status | Filter orders by payment status. Multiple selections allowed. Options: Failed, Paid, Partially Paid, Waiting. |
Output
The node outputs an array of JSON objects representing orders that match the specified criteria. Each object contains detailed information about an individual order as returned by the IKAS API. The exact structure depends on the API response but typically includes fields such as order ID, customer details, order status, payment status, and package status.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential for authenticating with the IKAS e-commerce platform API.
- The node uses the base URL
https://api.myikas.com/api/v1/adminfor API requests. - Pagination and filtering are handled via the IKAS API endpoints internally.
- No additional external dependencies beyond the IKAS API and n8n's standard HTTP request capabilities.
Troubleshooting
Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- Using incompatible filter values may result in empty responses.
- Network connectivity problems can prevent successful API calls.
- Exceeding rate limits imposed by the IKAS API could lead to errors or throttling.
Error messages:
"Resource "order" is not yet implemented": Indicates the resource parameter was set incorrectly or the node does not support it."Operation "getMany" is not yet implemented for resource "order": Means the operation parameter is invalid or unsupported.- API errors returned from IKAS will be surfaced; check the error message for details.
Resolutions:
- Verify API credentials and permissions.
- Double-check filter values and ensure they conform to expected formats.
- Use the "Fetch All Items" option carefully to avoid long-running executions if many orders exist.
- Handle errors gracefully by enabling "Continue On Fail" if partial data retrieval is acceptable.
Links and References
- IKAS e-commerce platform API documentation (refer to official IKAS docs for detailed API specs).
- n8n documentation on creating and configuring nodes with pagination and filtering.
- General best practices for API authentication and error handling in n8n workflows.