Shopware icon

Shopware

Shopware

Actions778

Product → Search Product

AI-generated

Overview

This node operation allows searching for products in a Shopware store using various search parameters. It is useful for retrieving product data based on filters, sorting, pagination, and other search criteria. For example, it can be used to fetch a specific page of products with a limit on the number of items, apply filters to narrow down the search results, sort products by certain fields, and include related associations or aggregations in the response.

Use Case Examples

  1. Retrieve the first page of products with a limit of 20 items per page.
  2. Search for products matching specific filter criteria such as category or price range.
  3. Sort products by name or price in ascending or descending order.
  4. Include related product associations like manufacturer or media in the search results.

Properties

Name Meaning
Page The page number of the search results to retrieve.
Limit The number of items to return per page in the search results.
Filter A JSON list of filters to restrict the search results based on product attributes or conditions.
Sort A JSON list defining the sorting order of the search results.
Post Filter A JSON list of filters applied after aggregations, which do not affect aggregation results.
Associations A JSON object specifying related entities to include in the search results.
Aggregations A JSON list defining aggregations to perform on the search results.
Grouping A JSON list specifying fields to group the search results by.
Fields A JSON list of fields to include 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).
Ids A JSON list of specific product 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 batching, SSL certificate validation, proxy, and timeout for the API request.

Output

JSON

  • data - The main search result data containing the list of products matching the search criteria.
  • total - The total number of products matching the search query, if total count mode is enabled.
  • aggregations - Aggregation results based on the search query, if aggregations are requested.

Dependencies

  • Shopware Store API credentials

Troubleshooting

  • Invalid JSON format in filter, sort, post-filter, associations, aggregations, grouping, fields, ids, or includes properties can cause request failures. Ensure JSON is correctly formatted.
  • Incorrect pagination values (page or limit) may result in empty or incomplete results. Verify that page and limit are set appropriately.
  • If the total count mode is set to 'exact', the request may be slow due to the calculation of the exact total number of hits.
  • SSL certificate validation errors can occur if the server uses a self-signed or invalid certificate. Use the 'Ignore SSL Issues' option to bypass this if necessary.
  • Proxy configuration errors can prevent the request from reaching the server. Double-check proxy settings if used.

Links

Discussion