Shopware icon

Shopware

Shopware

Actions778

User → Search User

AI-generated

Overview

This node performs a search operation for users in the Shopware system. It allows querying user data with various filters, sorting options, pagination, and other advanced search parameters. This is useful for scenarios where you need to retrieve user information based on specific criteria, such as filtering users by attributes, sorting results, or limiting the number of results per page.

Use Case Examples

  1. Retrieve a list of users filtered by a specific attribute, such as role or status.
  2. Paginate through user search results by specifying the page number and limit per page.
  3. Sort users by creation date or name.
  4. Apply complex filters and aggregations to analyze user data.

Properties

Name Meaning
Page The page number of the search results to retrieve, used for pagination.
Limit The number of user items to return per page in the search results.
Filter A JSON array of filters to restrict the search results based on user attributes.
Sort A JSON array specifying the sorting order of the search results.
Post Filter Filters applied after aggregations that do not affect the aggregation results.
Associations JSON object specifying related entities to include in the search results.
Aggregations JSON array defining aggregations to perform on the search results.
Grouping JSON array specifying fields to group the search results by.
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 user IDs to search for.
Includes JSON object specifying fields to include for given entities, affecting API-level response filtering.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout.

Output

JSON

  • data - The search results containing user data matching the query.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have sufficient permissions to perform user searches.
  • Verify that JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • If using pagination, ensure the page and limit values are within valid ranges to prevent empty or incomplete results.
  • Check network settings such as proxy and SSL options if requests fail due to connectivity or certificate issues.

Links

Discussion