Shopware icon

Shopware

Shopware

Actions778

Customer Recovery → Get Customer Recovery List

AI-generated

Overview

This node operation retrieves a list of customer recovery records from the Shopware platform. It is useful for scenarios where you need to fetch paginated customer recovery data, such as for analysis, reporting, or integration with other systems. For example, you can use it to get a specific page of customer recovery entries with a limit on the number of records per page, optionally filtering the results using a SwagQL query.

Use Case Examples

  1. Fetch the first 50 customer recovery records to display in a dashboard.
  2. Retrieve the second page of customer recovery data with a custom query filter to analyze specific customer recovery cases.

Properties

Name Meaning
Limit Maximum number of customer recovery records to return in one page.
Page The page number of the customer recovery list to retrieve.
Query Encoded SwagQL query in JSON format to filter or customize the customer recovery data returned.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and timeout settings to control the API request behavior.

Output

JSON

  • data - Array of customer recovery records returned from the API.
  • total - Total number of customer recovery records available.
  • page - Current page number of the returned data.
  • limit - Maximum number of records returned per page.

Dependencies

  • Shopware API credentials (API key or token)

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have the necessary permissions to access customer recovery data.
  • Verify that the 'limit' and 'page' parameters are set to valid numbers to avoid request errors.
  • If using a custom SwagQL query, ensure the query is properly encoded and valid to prevent API errors.
  • Check network settings if using proxy or SSL options to avoid connectivity issues.

Discussion