Shopware icon

Shopware

Shopware

Actions778

Order Transaction Capture Refund Position → Search Order Transaction Capture Refund Position

AI-generated

Overview

This node performs a search operation on the 'Order Transaction Capture Refund Position' resource in the Shopware system. It allows users to query and retrieve specific refund position data related to order transactions, supporting pagination, filtering, sorting, and other advanced search features. This is useful for scenarios where detailed refund transaction data is needed for analysis, reporting, or integration with other systems.

Use Case Examples

  1. Retrieve a paginated list of refund positions for order transactions with specific filters applied.
  2. Sort refund positions by date or amount to analyze refund trends.
  3. Use filters and aggregations to generate reports on refund positions within a certain period.

Properties

Name Meaning
Page The page number of the search result to retrieve, used for pagination.
Limit The number of items to return per page in the search result.
Filter A JSON array of filters to restrict the search results based on specific criteria.
Sort A JSON array defining the sorting order of the search results.
Post Filter Filters applied after aggregations that do not affect the aggregation results.
Associations JSON object defining related entities to include in the search results.
Aggregations JSON array defining aggregations to perform on the search results.
Grouping JSON array specifying fields to group the search results by.
Fields JSON array specifying which fields should be returned in the search results.
Total Count Mode Option to determine how the total number of hits is calculated: none (disabled), exact (slow but accurate), or next-pages (fast for next page).
Ids JSON array of specific IDs to search for.
Includes JSON object specifying fields to include for given entities, used to control returned data at the API level.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout.

Output

JSON

  • data - The array of refund position records matching the search criteria.
  • total - The total number of matching refund position records.
  • aggregations - Aggregation results based on the search query.

Dependencies

  • Shopware API credentials

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have the necessary permissions to access order transaction refund data.
  • Verify that JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If using total count modes, be aware that 'exact' mode can slow down the response time significantly.

Links

Discussion