Shopware icon

Shopware

Shopware

Actions778

Property Group → Search Property Group

AI-generated

Overview

This node operation allows searching for property groups within the Shopware platform. It supports pagination, filtering, sorting, and various advanced search options to refine the search results. This is useful for scenarios where you need to retrieve specific property groups based on criteria such as filters, sorting order, or specific fields, for example, when managing product attributes or configurations in an e-commerce setup.

Use Case Examples

  1. Retrieve the first page of property groups with a limit of 10 items per page.
  2. Search property groups with specific filters applied, such as filtering by a certain attribute or status.
  3. Sort property groups by a particular field and include only selected fields in the response.

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 Filters applied to the search results without affecting aggregations, used for additional filtering after the main query.
Associations JSON object defining related entities to include in the search results.
Aggregations JSON array specifying aggregations to perform on the search results.
Grouping JSON array defining groupings over certain fields in the search results.
Fields 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 JSON array of specific IDs to search for.
Includes JSON object specifying fields to be returned for given entities, used to control the response content.

Output

JSON

  • data - The array of property group objects returned from the search.
  • total - The total number of property groups matching the search criteria.
  • aggregations - Aggregated data based on the search query, if any aggregations were requested.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access property groups.
  • Verify that the JSON input for filters, sorting, and other advanced options is correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', be aware that the request might be slower due to the calculation of the total number of hits.
  • Check network connectivity and proxy settings if requests fail or time out.

Links

Discussion