Shopware icon

Shopware

Shopware

Actions778

Product Media → Search Product Media

AI-generated

Overview

This node operation allows searching for product media within the Shopware platform. It is useful for retrieving media assets related to products, such as images or videos, based on various search criteria. Common scenarios include filtering media by specific attributes, sorting results, paginating through large sets of media, and customizing the fields returned in the search results.

Use Case Examples

  1. A user wants to retrieve all media associated with a specific product category, applying filters to only get images uploaded after a certain date.
  2. A user needs to paginate through product media results, limiting the number of items per page and sorting them by upload date.
  3. A user wants to perform an advanced search with custom filters, aggregations, and groupings to analyze media usage across products.

Properties

Name Meaning
Page The page number of the search results to retrieve, used for pagination.
Limit The number of 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 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 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 duration.

Output

JSON

  • data - The array of product media items returned from the search.
  • total - The total number of product media items matching the search criteria.
  • aggregations - Aggregation results if aggregations were requested in the search.

Dependencies

  • Shopware API credentials

Troubleshooting

  • Invalid JSON in filter, sort, post-filter, aggregations, grouping, fields, ids, or includes properties can cause request failures. Ensure JSON is well-formed.
  • Incorrect pagination parameters (page or limit) may result in empty or incomplete results.
  • Using 'exact' total count mode can slow down the response significantly on large datasets.
  • SSL certificate validation errors can occur if 'Ignore SSL Issues' is not enabled when using self-signed certificates.
  • Proxy misconfiguration can prevent the node from connecting to the Shopware API.

Links

Discussion