Shopware icon

Shopware

Shopware

Actions778

User Config → Search User Config

AI-generated

Overview

This node operation allows searching user configuration data within the Shopware platform. It supports detailed search queries with pagination, filtering, sorting, and field selection, enabling users to retrieve specific user configuration records efficiently. This is useful in scenarios where you need to query user settings or preferences stored in Shopware, such as fetching configurations for user interface customization or user-specific settings management.

Use Case Examples

  1. Retrieve the first page of user configurations with a limit of 10 items per page.
  2. Search user configurations with specific filters applied, such as filtering by user role or status.
  3. Sort user configurations by creation date in descending order and include only selected fields in the response.

Properties

Name Meaning
Page The page number of the search result to retrieve, used for pagination.
Limit The number of items to return per page in the search result, controlling the page size.
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 aggregation results.
Associations A JSON object specifying related entities to include in the search results.
Aggregations A JSON array defining aggregations to perform on the search results.
Grouping A JSON array specifying fields to group the search results by.
Fields A JSON array listing the fields to 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 which fields should be returned for given entities, used to control the response content.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout duration.

Output

JSON

  • data - The array of user configuration records returned from the search.
  • total - The total number of user configuration records matching the search criteria.
  • aggregations - Aggregation results if any aggregations were requested in the search.

Dependencies

  • An API key credential for Shopware Admin API access

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access user configuration data.
  • 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 request may be slow for large datasets; consider using 'next-pages' or 'none' for better performance.
  • Check network settings such as proxy and SSL options if requests fail due to connectivity or certificate issues.

Links

Discussion