avanta icon

avanta

Consume avanta API

Actions57

Requests - Return Registration → Get Many

AI-generated

Overview

This node operation retrieves multiple return registration requests from the Avanta API. It is useful for scenarios where you need to fetch a list of return requests, such as for processing returns, auditing, or reporting purposes. For example, a user can fetch all return registrations or apply filters to narrow down the results based on specific criteria.

Use Case Examples

  1. Fetch all return registration requests to display in a dashboard.
  2. Retrieve return registrations with specific filters to analyze return trends.

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 limit the number of results returned.
Limit Maximum number of results to return.
Filter Type of filter to apply to the results, either none or JSON-based filter.
Filters (JSON) JSON string representing the filter criteria to apply when retrieving return registrations.

Output

JSON

  • returnRegistrations - Array of return registration request objects retrieved from the API.
  • debugInfo - Optional debug information including API request details if debug mode is enabled.

Dependencies

  • Avanta API with API key credential

Troubleshooting

  • If the node fails to connect, check the API key credential and network connectivity.
  • Timeout errors can occur if the server is slow or unresponsive; increase the timeout value if needed.
  • Invalid JSON filter strings will cause errors; ensure the filter JSON is correctly formatted.

Links

Discussion