Shopware icon

Shopware

Shopware

Actions778

Order Transaction Capture → Search Order Transaction Capture

AI-generated

Overview

This node performs a search operation on Order Transaction Captures within the Shopware platform. It allows users to query and retrieve order transaction capture data based on various criteria such as pagination, filtering, sorting, and field selection. This is useful for scenarios where you need to analyze or process specific order transaction captures, for example, fetching captures for reporting, auditing, or integration with other systems.

Use Case Examples

  1. Retrieve the first page of order transaction captures with a limit of 20 items per page.
  2. Search order transaction captures filtered by a specific status or date range.
  3. Sort order transaction captures by creation date in descending order and include only specific fields in the response.

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 conditions.
Sort A JSON array defining the sorting order of the search results.
Post Filter A JSON array of filters applied after aggregations, which do not affect aggregation results.
Associations A JSON object defining related entities to include in the search results.
Aggregations A JSON array specifying aggregations to perform on the search results.
Grouping A JSON array defining groupings over certain fields in the search results.
Fields A 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 only).
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to be returned for given entities, used to control the response content.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout.

Output

JSON

  • data - The array of order transaction capture records returned from the search.
  • total - The total number of matching order transaction captures based on the search criteria.
  • aggregations - Aggregation results if any aggregations were specified in the search.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access order transaction capture data.
  • Verify that JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', be aware that the query might be slower; consider using 'next-pages' for faster performance if exact count is not critical.
  • Check network settings such as proxy and SSL options if requests fail due to connectivity or certificate issues.

Links

Discussion