Shopware icon

Shopware

Shopware

Actions778

Media Folder → Search Media Folder

AI-generated

Overview

This node performs a search operation on Media Folders within the Shopware platform. It allows users to query media folders with various parameters such as pagination (page and limit), filtering, sorting, and grouping. This is useful for retrieving specific media folder data based on complex search criteria, for example, to display media folders in a custom application or to process media folder data in workflows.

Use Case Examples

  1. Retrieve the first page of media folders with a limit of 10 items per page.
  2. Search media folders with specific filters applied, such as folders created after a certain date.
  3. Sort media folders by name or creation date.
  4. Use aggregations and groupings to analyze media folder data.

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 the aggregation results.
Associations A JSON object defining related entities to include in the search results.
Aggregations A JSON array defining aggregations to perform on the search results.
Grouping A JSON array defining fields to group the search results by.
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 media folder 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.

Output

JSON

  • data - The search results containing media folder data matching the query.
  • total - The total number of media folders matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results if aggregations were requested in the search.

Dependencies

  • Shopware API with appropriate credentials

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have permissions to access media folder data.
  • Verify that JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • If using pagination, ensure the page and limit values are within valid ranges to avoid empty results.
  • Check network connectivity and proxy settings if requests fail or time out.

Links

Discussion