Overview
This node interacts with the Getfly CRM API to retrieve sales order data. Specifically, the "Sales Order" resource with the "Get All" operation fetches multiple sales orders from the system based on user-defined criteria such as fields to return, pagination limits, sorting, and filtering by order ID or order date range.
Common scenarios for this node include:
- Extracting a list of recent sales orders for reporting or analysis.
- Synchronizing sales order data into another system or database.
- Filtering sales orders within a specific date range or by particular order IDs for targeted processing.
For example, a user might configure the node to retrieve all sales orders placed in the last month, sorted by order date descending, returning only the order code, amount, and date fields.
Properties
| Name | Meaning |
|---|---|
| Fields | Comma-separated list of sales order fields to retrieve (e.g., id,order_code,real_amount). |
| Limit | Maximum number of sales orders to return (pagination limit). |
| Offset | Number of sales orders to skip before starting to collect results (pagination offset). |
| Additional Options | Collection of optional parameters: |
| - Sort By | Field to sort results by; options are ID or Order Date. |
| - Sort Direction | Direction to sort results; options are Ascending or Descending. |
| - Filter by ID | Filter results to only include sales orders matching this exact order ID. |
| - Filter by Order Date From | Filter results to only include sales orders with order dates on or after this date/time. |
| - Filter by Order Date To | Filter results to only include sales orders with order dates on or before this date/time. |
Output
The node outputs an array of JSON objects representing sales orders. Each object contains the fields requested via the "Fields" property. For example, if the default fields are used, each sales order object will include:
id: Unique identifier of the sales order.order_code: Code associated with the order.real_amount: The actual amount of the order.account_id: Identifier of the customer account related to the order.order_date: Date when the order was placed.
No binary data is output by this node.
Dependencies
- Requires an active connection to the Getfly CRM API.
- Needs an API key credential configured in n8n to authenticate requests.
- The node uses HTTP GET requests to the Getfly API endpoints under
/api/v6/sale_orders. - The base URL domain must be provided in the credentials and is normalized to ensure it starts with
https://.
Troubleshooting
- API Authentication Errors: If the API key is invalid or missing, the node will throw an error indicating authentication failure. Ensure the API key credential is correctly set up.
- Invalid Filter Values: Providing incorrectly formatted dates or invalid IDs in filters may cause the API to reject the request. Verify filter inputs conform to expected formats.
- Network Issues: Connectivity problems to the Getfly API endpoint can cause timeouts or failures. Check network access and API availability.
- Unexpected API Responses: If the API returns errors, the node surfaces the message prefixed with "Getfly API Error". Review the message for details and adjust parameters accordingly.
Links and References
- Getfly CRM API Documentation (example link; replace with actual if available)
- n8n Documentation on Creating Custom Nodes