Shopware icon

Shopware

Shopware

Actions778

Customer → Search Customer

AI-generated

Overview

This node operation allows searching for customers in a Shopware system using various search parameters. It is useful for retrieving customer data based on filters, sorting, pagination, and other search criteria. For example, it can be used to find customers who meet specific conditions, sort them by certain fields, or limit the number of results per page.

Use Case Examples

  1. Search customers by email domain using filters.
  2. Retrieve a paginated list of customers sorted by registration date.
  3. Get specific fields of customers with certain IDs.

Properties

Name Meaning
Page The page number of the search results to retrieve.
Limit The number of items to return per result page.
Filter A list of filters to restrict the search results based on specific criteria.
Sort Sorting criteria to order the search results.
Post Filter Filters applied without affecting aggregations in the search results.
Associations Associations to include in the search results.
Aggregations Aggregations to perform on the search results.
Grouping Grouping criteria to group the search results over certain fields.
Fields Specific fields to be returned in the search results.
Total Count Mode Determines how the total number of hits is calculated for the search query. Options include none (disabled), exact (slow but accurate), and next-pages (fast for next page).
Ids List of customer IDs to search for.
Includes Specify fields to be returned for given entities, improving API-level filtering.
Request Options Additional request options such as batching, SSL handling, proxy, and timeout settings.

Output

JSON

  • data - The array of customer objects returned from the search.
  • total - The total number of customers matching the search criteria.
  • aggregations - Aggregated data based on the search query, if any.

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 data.
  • Verify that JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If using total count modes, be aware that 'exact' mode can be slow and may impact performance.

Links

Discussion