avanta icon

avanta

Consume avanta API

Actions57

Servicecenter - Credit Memo → Get Many

AI-generated

Overview

This node interacts with the Avanta API to retrieve multiple credit memos from the Servicecenter resource. It supports fetching a list of credit memos with options to include detailed positions, apply filters, control the number of results returned, and enable debugging or SSL options. This is useful for scenarios where users need to gather credit memo data for reporting, auditing, or integration with other systems.

Use Case Examples

  1. Retrieve all credit memos with detailed positions included for a comprehensive report.
  2. Fetch a limited number of credit memos with specific JSON filters applied to narrow down results.
  3. Enable debug mode to troubleshoot API request issues when fetching credit memos.

Properties

Name Meaning
Request Options Options to control API request behavior such as debug mode, SSL certificate validation, and request timeout.
With Positions Whether to include detailed positions in the credit memo response.
Return All Whether to return all credit memo results or limit the number of results.
Limit Maximum number of credit memo results to return.
Filter Type of filter to apply to the credit memo query, e.g., none or JSON.
Filters (JSON) JSON string representing filters to apply to the credit memo query.

Output

JSON

  • creditmemos - Array of credit memo objects retrieved from the API, optionally including positions if requested.
  • debugInfo - API request details such as method, URL, and body included when debug mode is enabled.

Dependencies

  • Avanta API with appropriate API key credentials

Troubleshooting

  • If the node fails to connect, check the SSL certificate settings and consider enabling 'Ignore SSL Issues' if using self-signed certificates.
  • Timeout errors can occur if the server is slow to respond; increase the timeout value in request options.
  • Invalid JSON filter syntax will cause errors; ensure the filter JSON is correctly formatted according to the Magento guide linked in the node properties.
  • Debug mode can help identify issues by showing the exact API request details in the output.

Links

Discussion