Shopware icon

Shopware

Shopware

Actions778

Plugin → Search Plugin

AI-generated

Overview

This node performs a search operation for plugins in the Shopware system. It allows users to specify various search parameters such as pagination (page and limit), filters, sorting, post-filters, associations, aggregations, grouping, fields to return, total count mode, specific IDs, and includes. This node is useful for retrieving detailed and customized plugin data from the Shopware store API, enabling scenarios like plugin management, analytics, or integration with other systems.

Use Case Examples

  1. Retrieve a paginated list of plugins with specific filters applied to find plugins matching certain criteria.
  2. Sort plugins by a specific attribute and limit the number of results per page for display in a dashboard.
  3. Use aggregations and groupings to analyze plugin data and generate reports.

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 conditions.
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 plugin IDs to search for.
Includes A JSON object specifying fields to include for given entities, optimizing the returned data.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout.

Output

JSON

  • data - The main search result data containing the list of plugins matching the search criteria.
  • total - The total number of plugins found matching the search criteria, depending on the total count mode.
  • aggregations - Aggregated data based on the specified aggregations in the search query.

Dependencies

  • An API key credential for authenticating with the Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access plugin data.
  • Verify that JSON inputs for filters, sorting, post-filters, associations, aggregations, grouping, fields, ids, and includes 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 exact total number of hits.
  • Check network settings such as proxy configuration and SSL certificate validation if requests fail or time out.

Links

Discussion