Shopware icon

Shopware

Shopware

Actions778

Product Review → Search Product Review

AI-generated

Overview

This node operation allows searching for product reviews within the Shopware platform. It supports detailed search queries with pagination, filtering, sorting, and field selection, enabling users to retrieve specific product review data efficiently. This is useful for scenarios like analyzing customer feedback, monitoring product ratings, or integrating review data into other systems.

Use Case Examples

  1. Retrieve the first page of product reviews with a limit of 10 reviews per page.
  2. Search product reviews filtered by specific criteria such as rating or date.
  3. Sort product reviews by date or rating in ascending or descending order.
  4. Fetch only selected fields from product reviews to optimize data usage.

Properties

Name Meaning
Page The page number of the search results to retrieve, used for pagination.
Limit The number of product review items to return per page in the search results.
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 to the search results without affecting aggregations, provided as a JSON array.
Associations A JSON object specifying related entities to include in the search results.
Aggregations A JSON array defining aggregations to perform on the search results.
Grouping A JSON array specifying fields to group the search results by.
Fields A JSON array listing the fields to 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 A JSON array of specific product review IDs to search for.
Includes A JSON object specifying which fields should be returned for given entities, used to control the API-level response.

Output

JSON

  • data - The array of product review objects returned from the search.
  • total - The total number of product reviews matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregated data based on the search query, if aggregations are requested.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access product reviews.
  • Verify that JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • If pagination parameters (page, limit) are set incorrectly, the search results may be empty or incomplete.
  • Using 'exact' total count mode may slow down the response time for large datasets.

Links

Discussion