Shopware icon

Shopware

Shopware

Actions778

Promotion Setgroup → Search Promotion Setgroup

AI-generated

Overview

This node performs a search operation on the Promotion Setgroup resource in the Shopware system. It allows users to query promotion set groups with various parameters such as pagination (page and limit), filtering, sorting, and aggregation. This is useful for retrieving specific promotion set groups based on complex search criteria, which can be applied in scenarios like marketing analysis, promotion management, or reporting within an e-commerce platform.

Use Case Examples

  1. Retrieve the first page of promotion set groups with a limit of 10 items per page.
  2. Search promotion set groups filtered by specific criteria such as active status or date range.
  3. Sort promotion set groups by creation date or name.
  4. Apply aggregations to group promotion set groups by certain fields for analytical purposes.

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 conditions.
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 perform on the search results for grouping or summarizing data.
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 for the search query.
Ids List of specific IDs to search for.
Includes Specify fields to be returned for given entities, optimizing the response.
Request Options Additional request options such as batching, SSL handling, proxy, and timeout settings.

Output

JSON

  • data - The search results containing the promotion set groups matching the query.
  • total - Total number of promotion set 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 sufficient permissions to access the Promotion Setgroup resource.
  • Verify that the JSON input for filters, sorting, and other parameters is correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', be aware that the query might be slow for large datasets.
  • Check network settings such as proxy and SSL options if requests fail or time out.

Links

Discussion