Shopware icon

Shopware

Shopware

Actions778

Product Search Config → Search Product Search Config

AI-generated

Overview

This node performs a search operation on the Product Search Config resource in the Shopware API. It allows users to query product search configurations with various parameters such as pagination (page, limit), filtering, sorting, post-filtering, associations, aggregations, grouping, and field selection. This node is useful for retrieving customized product search configurations based on specific criteria, which can be applied in e-commerce platforms to tailor product search results.

Use Case Examples

  1. Retrieve the first page of product search configurations with a limit of 10 items per page.
  2. Search product search configurations with specific filters to narrow down results based on attributes.
  3. Sort product search configurations by a certain field and apply grouping to organize the results.

Properties

Name Meaning
Page Search result page number for pagination.
Limit Number of items to return per result page.
Filter List of filters to restrict the search results based on specific criteria.
Sort Sorting criteria to order the search results.
Post Filter Filters applied without affecting aggregations, used to refine search results.
Associations Associations to include related entities in the search results.
Aggregations Aggregations to summarize or group data in the search results.
Grouping Fields to perform groupings over in the search results.
Fields Specific fields to be returned in the search results.
Total Count Mode Mode to determine how the total number of hits is calculated for the search query.
Ids List of specific IDs to search for.
Includes Specify fields to be returned for given entities, optimizing the response.
Request Options Additional request settings such as batching, SSL handling, proxy, and timeout.

Output

JSON

  • data - The main search result data containing product search configurations matching the query.
  • total - Total number of items matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregated data summarizing the search results based on specified aggregations.

Dependencies

  • Shopware API with appropriate 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.
  • Using 'exact' total count mode may slow down the response time due to the calculation of the exact total number of hits.
  • SSL certificate validation issues can be bypassed by enabling the 'Ignore SSL Issues' option, but this should be used cautiously due to security risks.

Links

Discussion