avanta icon

avanta

Consume avanta API

Actions57

Company - Address → Get Many

AI-generated

Overview

This node operation retrieves multiple company address records from the Avanta API. It is useful for scenarios where you need to fetch a list of company addresses, such as for displaying in a CRM system, syncing address data, or performing bulk address analysis.

Use Case Examples

  1. Fetch all company addresses with no filters to get a complete list.
  2. Retrieve a limited number of company addresses for pagination or preview purposes.
  3. Use JSON filters to narrow down the addresses returned based on specific criteria.

Properties

Name Meaning
Request Options Options to customize the API request behavior, including debug mode, SSL certificate validation, and request timeout.
Return All Whether to return all results or only up to a given limit.
Limit Maximum number of results to return when not returning all.
Filter Type of filter to apply to the results, either none or JSON-based filtering.
Filters (JSON) JSON string representing the filters to apply when filter type is JSON.

Output

JSON

  • data - Array of company address records retrieved from the API.
  • debugInfo - Optional debug information about the API request if debug mode is enabled.

Dependencies

  • Avanta API with appropriate API key credentials

Troubleshooting

  • If the node returns SSL errors, enable 'Ignore SSL Issues' to bypass certificate validation (not recommended for production).
  • If no results are returned, verify the JSON filter syntax and criteria are correct according to the Magento guide linked in the node properties.
  • Timeout errors can be resolved by increasing the 'Timeout' value in request options.

Links

Discussion