Shopware icon

Shopware

Shopware

Actions778

Property Group Option → Search Property Group Option

AI-generated

Overview

This node operation allows searching for Property Group Options within the Shopware platform. It supports detailed search queries with pagination, filtering, sorting, and other advanced search parameters. This is useful for retrieving specific property group options based on various criteria, such as filtering by attributes, sorting results, and controlling the number of results per page.

Use Case Examples

  1. Retrieve a paginated list of property group options with specific filters applied.
  2. Sort property group options by a certain field and limit the number of results per page.
  3. Use aggregations and groupings to analyze property group options data.

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 Filters applied after aggregations that do not affect the aggregation results.
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).
Ids JSON array of specific IDs to search for.
Includes JSON object specifying fields to include for given entities, used to control returned data fields.

Output

JSON

  • data - The array of property group options returned by the search.
  • total - The total number of matching property group options found.
  • aggregations - Aggregation results based on the search query.

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 group options.
  • Verify that JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', be aware that the query might be slower due to the calculation of the exact total count.
  • Check network connectivity and proxy settings if requests fail or time out.

Links

Discussion