Shopware icon

Shopware

Shopware

Actions778

Product Keyword Dictionary → Search Product Keyword Dictionary

AI-generated

Overview

This node performs a search operation on the Product Keyword Dictionary resource in the Shopware API. It allows users to query the product keyword dictionary with various parameters such as pagination (page, limit), filtering, sorting, and grouping. This is useful for retrieving specific product keyword data based on complex search criteria, which can help in managing product keywords effectively in an e-commerce environment.

Use Case Examples

  1. Retrieve the first page of product keywords with a limit of 20 items per page.
  2. Search product keywords with specific filters to find keywords related to a certain category or attribute.
  3. Sort product keywords by relevance or creation date.
  4. Use aggregations and groupings to analyze keyword data distribution.

Properties

Name Meaning
Page The page number of the search results to retrieve, used for pagination.
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 aggregation operations to perform on the search results.
Grouping A JSON array specifying fields to group the search results by.
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 only).
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 search results containing product keyword dictionary entries.
  • total - The total number of matching entries found by the search.
  • aggregations - Aggregation results based on the search query, if any aggregations were requested.

Dependencies

  • Shopware API with appropriate credentials

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have the necessary permissions to access the Product Keyword Dictionary resource.
  • Verify that JSON inputs for filters, sorting, post-filters, associations, aggregations, grouping, fields, ids, and includes are correctly formatted and valid JSON.
  • If the total count mode is set to 'exact', be aware that the query might be slow for large datasets.
  • Check network connectivity and proxy settings if requests fail or time out.

Links

Discussion