Actions8
- Company Actions
- CompanyAddress Actions
- CompanyUser Actions
- SalesOrg Actions
Overview
This node interacts with the "SalesOrg" resource of the Avanta API to retrieve multiple sales organization records. It is designed to fetch either a limited number of sales organizations or all available ones, optionally applying filters to narrow down the results. This functionality is useful in scenarios where you need to list or process sales organizations from Avanta, such as syncing sales org data into another system, generating reports, or performing bulk operations.
For example, you might use this node to:
- Retrieve the first 5 sales organizations for display in a dashboard.
- Fetch all sales organizations matching specific criteria defined by JSON filters.
- Integrate sales organization data into a CRM or ERP system.
Properties
| Name | Meaning |
|---|---|
| Return to Webhook | Boolean flag indicating if the node should return its response directly to a webhook node downstream. |
| Return All | Whether to return all sales organization records or limit the number of results returned. |
| Limit | Maximum number of sales organization records to return when not returning all (minimum 1, maximum 10). |
| Filter | Type of filter to apply: "None" for no filtering, or "JSON" to specify filters using a JSON string. |
| Filters (JSON) | JSON string defining filters according to Magento's REST API search criteria format (see linked Magento guide). |
Output
The node outputs an array of sales organization objects in the json field of each item. Each object represents a sales organization record retrieved from the Avanta API. The exact structure of these objects depends on the API but typically includes identifiers and descriptive fields relevant to sales organizations.
If the "Return to Webhook" property is enabled, the node prepares the response to be sent back through a webhook node, facilitating synchronous API responses.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential for authenticating with the Avanta API.
- Depends on the Avanta API being accessible and properly configured.
- The node references Magento's REST API filtering syntax for advanced filtering, so familiarity with that format is beneficial.
- A "Respond to Webhook" node is required downstream if "Return to Webhook" is set to true.
Troubleshooting
Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- Invalid JSON in the "Filters (JSON)" property can lead to request errors; ensure JSON is well-formed and follows Magento's filter specification.
- Setting "Return All" to true may result in large data sets; consider API rate limits or timeouts.
- If "Return to Webhook" is enabled without a subsequent webhook node, the workflow may not behave as expected.
Error messages:
- Authentication errors indicate invalid or missing API keys; verify credentials.
- Validation errors on filters suggest malformed JSON or unsupported filter parameters; validate JSON and consult the Magento filtering guide.
- API timeout or rate limit errors require adjusting limits or implementing retries.
Links and References
- Magento REST API Filtering Guide — Reference for constructing JSON filters used in the node.