Shopware icon

Shopware

Shopware

Actions778

Product Search Keyword → Search Product Search Keyword

AI-generated

Overview

This node performs a search operation on Product Search Keywords within the Shopware platform. It allows users to query product search keywords with various parameters such as pagination, filtering, sorting, and aggregations. This is useful for scenarios where you want to retrieve specific product search keywords based on complex search criteria, for example, to analyze search trends or optimize product search results.

Use Case Examples

  1. Retrieve the first page of product search keywords with a limit of 10 items per page.
  2. Search product search keywords with specific filters and sorting to find the most relevant keywords.
  3. Use aggregations and groupings to analyze keyword data distribution.

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 array of filters to restrict the search results based on specific criteria.
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 the aggregation results.
Associations A JSON object defining related entities to include in the search results.
Aggregations A JSON array defining aggregations to perform on the search results.
Grouping A JSON array defining groupings to perform 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 accurate), or next-pages (fast for next page).
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to include for given entities, used to control returned data at the API level.

Output

JSON

  • data - The array of product search keyword objects returned by the search.
  • total - The total number of matching product search keywords found.
  • aggregations - Aggregation results based on the search query, if any.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have the necessary permissions.
  • Verify that JSON inputs (filters, sort, post-filter, aggregations, grouping, fields, ids, includes) are correctly formatted and valid JSON.
  • If the total count mode is set to 'exact', expect slower response times for large datasets.
  • Check network connectivity and proxy settings if requests fail or time out.

Links

Discussion