Shopware icon

Shopware

Shopware

Actions778

Product Stream Filter → Search Product Stream Filter

AI-generated

Overview

This node performs a search operation on Product Stream Filters within the Shopware platform. It allows users to query product stream filters with various parameters such as pagination (page and limit), filtering criteria, sorting, post-filters, associations, aggregations, grouping, and field selection. This is useful for retrieving specific product stream filters based on complex search queries, which can be applied in e-commerce scenarios to dynamically filter and display products.

Use Case Examples

  1. Retrieve the first page of product stream filters with a limit of 10 items per page.
  2. Search product stream filters with specific filter criteria and sort the results by a certain field.
  3. Use aggregations and groupings to analyze product stream filters data.

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 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 exact count), or next-pages (fast count for next pages).
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to be returned for given entities, used to control the response content.

Output

JSON

  • total - Total number of matching product stream filters found.
  • elements - Array of product stream filter objects returned by the search.
  • aggregations - Aggregation results if any aggregations were requested.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Ensure the JSON input for filters, sort, post-filter, associations, aggregations, grouping, fields, ids, and includes is correctly formatted to avoid parsing errors.
  • If the API returns errors related to authentication, verify that the Shopware API credentials are correctly configured and valid.
  • Timeouts or SSL issues can occur; adjust the timeout and SSL settings in the request options if needed.

Links

Discussion