Shopware icon

Shopware

Shopware

Actions778

Customer Group → Search Customer Group

AI-generated

Overview

This node operation allows searching for customer groups within the Shopware platform. It supports pagination, filtering, sorting, and various advanced search query options to refine the search results. This is useful for scenarios where you need to retrieve specific customer group data based on criteria such as page number, limit of results per page, filters, sorting order, and other search parameters.

Use Case Examples

  1. Retrieve the first page of customer groups with a limit of 10 items per page.
  2. Search customer groups with specific filters applied, such as groups created after a certain date.
  3. Sort customer groups by name or creation date.
  4. Use aggregations and groupings to analyze customer group 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 list of filters to restrict the search results based on specific criteria.
Sort A JSON list defining the sorting order of the search results.
Post Filter Filters applied to the search results without affecting aggregations.
Associations JSON object defining related entities to include in the search results.
Aggregations JSON list defining aggregations to perform on the search results.
Grouping JSON list defining groupings over certain fields in the search results.
Fields JSON list specifying which fields should be returned in the search results.
Total Count Mode Option to determine how the total number of hits is calculated for the search query. Options include none (disabled), exact (slow but exact count), and next-pages (fast count for next pages).
Ids JSON list of specific customer group IDs to search for.
Includes JSON object specifying fields to be returned for given entities, allowing fine control over returned data.

Output

JSON

  • data - The array of customer group objects returned from the search.
  • total - The total number of customer groups matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results based on the search query, if aggregations are used.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access customer group data.
  • Verify that JSON inputs for filters, sort, post-filter, associations, aggregations, grouping, fields, ids, and includes 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 exact count calculation.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If SSL issues occur, consider enabling the option to ignore SSL certificate validation, but only if you trust the network environment.

Links

Discussion