Shopware icon

Shopware

Shopware

Actions778

Customer Recovery → Search Customer Recovery

AI-generated

Overview

This node operation allows searching for customer recovery data within the Shopware platform. It is useful for retrieving paginated lists of customer recovery records based on various search criteria such as filters, sorting, and specific fields. This can be applied in scenarios like analyzing customer recovery trends, managing recovery campaigns, or integrating recovery data into other systems.

Use Case Examples

  1. Retrieve the first page of customer recovery records with a limit of 20 items per page.
  2. Search customer recovery data filtered by specific criteria such as date ranges or customer segments.
  3. Sort customer recovery results by date or status to prioritize follow-up actions.

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 array of filters to restrict the search results based on specific conditions.
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 defining related entities to include in the search results.
Aggregations A JSON array specifying aggregations to perform on the search results.
Grouping A JSON array defining groupings over certain fields in the search results.
Fields A 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 only).
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to include for given entities, optimizing the returned data.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout.

Output

JSON

  • data - The main search result data containing customer recovery records.
  • total - The total number of hits matching the search criteria.
  • aggregations - Aggregation results if any aggregations were requested.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Ensure the JSON input for filters, sorting, and other JSON properties is correctly formatted to avoid parsing errors.
  • If the API returns authentication errors, verify that the Shopware API credentials are correctly configured and valid.
  • Timeout errors may occur if the server is slow or unresponsive; adjust the timeout setting in request options accordingly.
  • If SSL certificate validation fails and you trust the endpoint, enable the option to ignore SSL issues.

Links

Discussion