Shopware icon

Shopware

Shopware

Actions778

Order Transaction → Search Order Transaction

AI-generated

Overview

This node operation allows searching for order transactions within the Shopware platform. It is useful for retrieving paginated lists of order transactions based on various search criteria such as filters, sorting, and specific fields. Practical applications include fetching order transaction data for reporting, analytics, or integration with other systems.

Use Case Examples

  1. Retrieve the first page of order transactions with a limit of 20 items per page.
  2. Search order transactions filtered by a specific status or date range.
  3. Sort order transactions by creation date in descending order.

Properties

Name Meaning
Page The page number of the search result to retrieve.
Limit The number of items to return per page in the search result.
Filter A list of filters to restrict the search results based on specific criteria.
Sort Sorting criteria to order the search results.
Post Filter Filters applied without affecting aggregations in the search results.
Associations Associations to include related entities in the search results.
Aggregations Aggregations to perform on the search results.
Grouping Fields to group the search results by.
Fields Specific fields to be returned in the search results.
Total Count Mode Determines how the total number of hits is calculated for the search query. Options include none (disabled), exact (slow but accurate), and next-pages (fast for next page).
Ids List of specific IDs to search for.
Includes Specify fields to be returned for given entities, improving performance by limiting returned data.

Output

JSON

  • data - The array of order transaction objects matching the search criteria.
  • total - The total number of order transactions matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results based on the search query, if aggregations are used.

Dependencies

  • Shopware API credentials

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have the necessary permissions to access order transactions.
  • 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, expect slower response times due to the calculation of the total number of hits.

Links

Discussion