Shopware icon

Shopware

Shopware

Actions778

Media Thumbnail → Search Media Thumbnail

AI-generated

Overview

This node performs a search operation for media thumbnails within the Shopware platform. It allows users to query media thumbnails with various parameters such as pagination (page and limit), filtering, sorting, and specifying fields to return. This is useful for scenarios where you need to retrieve specific media thumbnail data from a Shopware store, for example, to display media assets in a custom application or to process media metadata in workflows.

Use Case Examples

  1. Retrieve the first page of media thumbnails with a limit of 10 items per page.
  2. Search media thumbnails filtered by specific criteria such as media type or creation date.
  3. Sort media thumbnails by a particular field, e.g., creation date, in ascending or descending order.
  4. Fetch only specific fields of media thumbnails to optimize data transfer and processing.

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 A JSON array of filters applied after aggregations, which do not affect aggregation results.
Associations A JSON object defining associations to include in the search results.
Aggregations A JSON array defining aggregations to perform on the search results.
Grouping A JSON array specifying 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 exact count), or next-pages (fast count for next pages).
Ids A JSON array of specific media thumbnail IDs to search for.
Includes A JSON object specifying fields to be returned for given entities, used to control the API-level response fields.
Request Options Node-level request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • data - The main search result data containing media thumbnail objects matching the query.
  • total - The total number of media thumbnails matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results if aggregations were requested in the search.

Dependencies

  • An API key credential for Shopware Admin API access

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access media thumbnail 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 slow on large datasets.
  • Check network settings such as proxy and SSL options if requests fail due to connectivity issues.

Links

Discussion