Shopware icon

Shopware

Shopware

Actions778

Product Search Config Field → Search Product Search Config Field

AI-generated

Overview

This node performs a search operation on the Product Search Config Field resource in the Shopware API. It allows users to query product search configuration fields with various parameters such as pagination (page, limit), filtering, sorting, post-filtering, associations, aggregations, grouping, and field selection. This is useful for retrieving customized search configurations for products, enabling advanced search and filtering capabilities in e-commerce workflows.

Use Case Examples

  1. Retrieve the first page of product search config fields with a limit of 10 items per page.
  2. Search product search config fields with specific filters and sorting criteria to tailor the search results.
  3. Use aggregations and groupings to analyze product search configurations for reporting or optimization.

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: none (disabled), exact (slow but accurate), or next-pages (fast for next page).
Ids List of specific IDs to search for.
Includes Specify fields to be returned for given entities, optimizing API response.

Output

JSON

  • data - The search results containing product search config fields matching the query.
  • total - Total number of matching items if total count mode is enabled.

Dependencies

  • Shopware API with appropriate credentials

Troubleshooting

  • Ensure the JSON input for filters, sorting, post-filters, associations, aggregations, grouping, fields, ids, and includes is correctly formatted to avoid parsing errors.
  • Check API credentials and base URL configuration to ensure successful connection to the Shopware API.
  • If the total count mode is set to 'exact', expect slower response times due to the calculation of the exact total number of hits.

Links

Discussion