Shopware icon

Shopware

Shopware

Actions778

User → Get User List

AI-generated

Overview

This node operation retrieves a list of users from the Shopware platform. It supports pagination and query filtering, allowing users to specify the maximum number of users to return per page, the page number to retrieve, and an encoded SwagQL query for advanced filtering. This operation is useful for scenarios where you need to fetch user data in a controlled and efficient manner, such as displaying user lists in an admin panel or processing user data in batches.

Use Case Examples

  1. Fetch the first 50 users by setting Limit to 50 and Page to 1.
  2. Retrieve users matching specific criteria by providing a SwagQL query in the Query parameter.

Properties

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

Output

JSON

  • users - Array of user objects returned from the Shopware API.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have the necessary permissions to access user data.
  • If the request times out, consider increasing the Timeout setting or checking network connectivity.
  • Invalid SwagQL queries in the Query parameter may result in errors; verify the query syntax and encoding.
  • If SSL certificate validation fails and you trust the source, enable the Ignore SSL Issues option to bypass validation.

Discussion