Shopware icon

Shopware

Shopware

Actions778

Rule → Get Rule List

AI-generated

Overview

This node operation retrieves a paginated list of rules from the Shopware system. It allows users to specify the maximum number of rules to return per page, the page number to fetch, and an optional query encoded in SwagQL JSON format to filter or customize the results. This operation is useful for scenarios where users need to fetch and process rule data from Shopware, such as for reporting, automation, or integration purposes.

Use Case Examples

  1. Fetch the first 50 rules to display in a dashboard.
  2. Retrieve rules on page 2 with a custom SwagQL query to filter active rules only.

Properties

Name Meaning
Limit Specifies the maximum number of rule resources to be returned in a single page of results.
Page Specifies which page of the paginated results to return.
Query An encoded SwagQL query in JSON format to filter or customize the list of rules returned.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and request timeout.

Output

JSON

  • rules - An array of rule objects returned from the Shopware API according to the specified query and pagination.

Dependencies

  • Requires Shopware API credentials for authentication and access.

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have sufficient permissions to access rule data.
  • Verify that the 'limit' and 'page' parameters are set to valid numbers to avoid request errors.
  • If using a custom SwagQL query, ensure it is properly encoded and valid to prevent query parsing errors.
  • Check network settings such as proxy and SSL options if requests fail due to connectivity or security issues.

Discussion