Shopware icon

Shopware

Shopware

Actions778

Customer → Get Customer List

AI-generated

Overview

This node operation retrieves a list of customers from the Shopware platform. It is useful for scenarios where you need to fetch customer data in a paginated manner, such as displaying customer lists in an admin panel, exporting customer data, or integrating customer information into other systems.

Use Case Examples

  1. Fetch the first 50 customers by setting Limit to 50 and Page to 1.
  2. Retrieve customers matching a specific query by providing an encoded SwagQL query in the Query property.

Properties

Name Meaning
Limit Maximum number of customer resources to be returned in a single page.
Page The page number of the customer list to be returned.
Query Encoded SwagQL query in JSON format to filter or customize the customer list retrieval.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and request timeout.

Output

JSON

  • data - The list of customers retrieved from the Shopware API.
  • meta - Metadata about the response, such as pagination details.

Dependencies

  • An API key credential for Shopware Admin API authentication

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access customer data.
  • Check that the limit and page parameters are set to valid numbers to avoid request errors.
  • If using a proxy or ignoring SSL issues, verify the network and security settings to prevent connection failures.
  • Common error messages may include authentication failures, invalid query syntax, or request timeouts. Verify the query format and increase timeout if needed.

Discussion