Shopware icon

Shopware

Shopware

Actions778

Order Transaction Capture Refund → Get Order Transaction Capture Refund List

AI-generated

Overview

This node operation retrieves a paginated list of order transaction capture refunds from the Shopware API. It is useful for scenarios where you need to fetch refund transaction data related to order captures, such as for financial reconciliation, reporting, or auditing purposes. For example, you can specify the number of refunds to retrieve per page and navigate through pages of results, or apply a SwagQL query to filter the refunds returned.

Use Case Examples

  1. Fetch the first 50 order transaction capture refunds to review recent refund activities.
  2. Retrieve refunds on page 2 with a specific SwagQL query to filter refunds by date or status.

Properties

Name Meaning
Limit Maximum number of refund resources to be returned in a single page of results.
Page The page number of the refund list to be returned, used for pagination.
Query Encoded SwagQL query in JSON format to filter or customize the refund list results.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and request timeout.

Output

JSON

  • data - Array of order transaction capture refund objects returned by the API.
  • meta - Metadata about the response, such as pagination details.

Dependencies

  • Shopware API with appropriate credentials

Troubleshooting

  • Ensure the API credentials are correctly configured and have permission to access order transaction capture refunds.
  • Verify that the 'limit' and 'page' parameters are set to valid numbers to avoid request errors.
  • If using a custom SwagQL query, ensure it is properly encoded and valid to prevent query errors.
  • Check network settings if using a proxy or if SSL certificate validation is disabled, as misconfiguration can cause request failures.

Discussion