Shopware icon

Shopware

Shopware

Actions778

Document Base Config → Get Document Base Config List

AI-generated

Overview

This node operation retrieves a paginated list of Document Base Configurations from the Shopware API. It is useful for scenarios where you need to fetch multiple document base configurations with control over pagination and filtering via a query. For example, you can use it to display or process document base configurations in batches, or to search for specific configurations using encoded SwagQL queries.

Use Case Examples

  1. Fetch the first 10 document base configurations to display in a dashboard.
  2. Retrieve page 2 of document base configurations with a specific filter query to process in a workflow.

Properties

Name Meaning
Limit Maximum number of document base configurations to return in one page.
Page The page number of results to return, used for pagination.
Query Encoded SwagQL query in JSON format to filter or customize the returned document base configurations.
Request Options Additional request settings such as batching, SSL certificate validation, proxy, and timeout options.

Output

JSON

  • data - Array of document base configuration objects returned from the API.
  • total - Total number of document base configurations available.
  • page - Current page number of the results.
  • limit - Maximum number of items returned per page.

Dependencies

  • Shopware API with appropriate credentials

Troubleshooting

  • Ensure the API credentials are correctly configured and have permission to access document base configurations.
  • 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 those settings to prevent connection failures.
  • Timeout errors may occur if the server is slow or unresponsive; consider increasing the timeout setting.

Discussion