Actions8
- Company Actions
- CompanyAddress Actions
- CompanyUser Actions
- SalesOrg Actions
Overview
This node integrates with the Avanta API to retrieve multiple company records. It is designed to fetch a list of companies, optionally filtered and limited in number. This functionality is useful in scenarios where you need to synchronize or process batches of company data from Avanta, such as generating reports, updating CRM systems, or performing bulk operations on company information.
For example, you might use this node to:
- Retrieve all companies matching specific criteria for further processing.
- Limit the number of companies fetched to avoid overwhelming downstream nodes.
- Use JSON-based filters to perform complex queries on company data.
Properties
| Name | Meaning |
|---|---|
| Return to Webhook | Boolean flag indicating if the node should return its response directly to a webhook. Requires a responding node after it. |
| Return All | Whether to return all matching company records or limit the results. |
| Limit | Maximum number of company records to return when not returning all (minimum 1, maximum 10). |
| Filter | Type of filter applied to the query: "None" for no filtering or "JSON" to specify filters in JSON format. |
| Filters (JSON) | JSON string defining the filters to apply to the company search query, following Magento's REST API filtering syntax. |
Note: The "Filters (JSON)" property is only shown if the filter type is set to JSON.
Output
The node outputs an array of company objects in the json field of each item. Each object represents a company record retrieved from the Avanta API. The exact structure of each company object depends on the API response but typically includes company details such as name, ID, and other relevant attributes.
If the "Return to Webhook" option is enabled, the node prepares the response to be sent back via a webhook, facilitating synchronous workflows.
No binary data output is indicated by the source code.
Dependencies
- Requires an API key credential for authenticating with the Avanta API.
- The node relies on the Avanta API endpoints for company data retrieval.
- Proper configuration of the API credentials within n8n is necessary.
- If using JSON filters, familiarity with Magento's REST API filtering syntax is beneficial (link provided in the property description).
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Incorrectly formatted JSON filters may result in API errors or empty responses.
- Setting "Return All" to true without proper pagination handling could lead to large data loads and potential timeouts.
- Using a limit outside the allowed range (1-10) will likely cause validation errors.
Error messages:
- Authentication errors indicate problems with the API key; verify and update credentials.
- JSON parsing errors suggest malformed filter JSON; validate the JSON syntax carefully.
- API rate limiting or timeout errors require adjusting request frequency or limits.
Links and References
- Magento REST API Filtering Guide — Detailed documentation on creating filters in JSON format compatible with this node’s filtering feature.