Shopware icon

Shopware

Shopware

Actions778

Product Sorting → Search Product Sorting

AI-generated

Overview

This node performs a search operation on product sorting configurations within a Shopware store. It allows users to retrieve sorted product data based on various criteria such as pagination, filtering, sorting, and aggregations. This is useful for scenarios where you want to customize or analyze how products are sorted in the storefront, for example, to display products sorted by popularity, price, or custom attributes.

Use Case Examples

  1. Retrieve the first page of product sorting results with a limit of 10 items per page.
  2. Search product sorting configurations filtered by specific criteria, such as sorting by price in ascending order.
  3. Apply aggregations and groupings to analyze product sorting data for reporting or customization purposes.

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 list of filters to restrict the search results based on specific conditions.
Sort A JSON object defining the sorting order of the search results.
Post Filter Filters applied after aggregations that do not affect the aggregation results.
Associations JSON object defining related entities to include in the search results.
Aggregations JSON list defining aggregations to perform on the search results.
Grouping JSON list defining fields to group the search results by.
Fields JSON list of specific fields to include in the search results.
Total Count Mode Option to specify how the total count of hits should be calculated: none (disabled), exact (slow but accurate), or next-pages (fast for next page).
Ids JSON list of specific IDs to search for.
Includes JSON object specifying which fields to include for given entities, used to control returned data fields.
Request Options Node-level settings for request batching, SSL certificate validation, proxy usage, and timeout configuration.

Output

JSON

  • data - The search results containing product sorting configurations matching the query.
  • total - The total number of matching product sorting entries, if total count mode is enabled.
  • aggregations - Aggregation results based on the search query, if aggregations were requested.

Dependencies

  • An API key credential for Shopware Admin API authentication

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access product sorting 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 for large datasets.
  • Check network settings such as proxy and SSL options if requests fail or time out.

Links

Discussion