Shopware icon

Shopware

Shopware

Actions778

Customer Group → Get Customer Group List

AI-generated

Overview

This node operation retrieves a list of customer groups from the Shopware platform. It is useful for scenarios where you need to fetch and manage customer group data, such as displaying customer groups in a dashboard, syncing customer group data with other systems, or performing analytics on customer segmentation.

Use Case Examples

  1. Fetch a paginated list of customer groups with a limit of 10 per page.
  2. Query customer groups using a custom SwagQL query to filter specific groups.

Properties

Name Meaning
Limit Specifies the maximum number of customer group resources to be returned in a single page of results.
Page Specifies which page of the customer group list to return, useful for pagination.
Query Allows sending an encoded SwagQL query in JSON format to filter or customize the customer group list results.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and request timeout.

Output

JSON

  • customerGroups - Array of customer group objects returned from the Shopware API.
  • pagination - Pagination details including current page, total pages, and total items.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have the necessary permissions to access customer group data.
  • If pagination parameters (limit and page) are set incorrectly, the node may return empty or incomplete results.
  • Invalid SwagQL queries in the 'Query' property can cause API errors; verify the query syntax and encoding.
  • Network issues or incorrect proxy settings can cause request failures; check proxy configuration and network connectivity.
  • Timeout settings that are too low may cause premature request termination; adjust the timeout as needed.

Discussion