Shopware icon

Shopware

Shopware

Actions778

Document → Get Document List

AI-generated

Overview

This node operation retrieves a list of documents from the Shopware API. It is useful for scenarios where you need to fetch multiple document records, such as generating reports, syncing document data with other systems, or displaying document lists in an application.

Use Case Examples

  1. Fetching the first 50 documents for review.
  2. Retrieving documents on a specific page to paginate results in a UI.
  3. Querying documents with specific criteria using encoded SwagQL queries.

Properties

Name Meaning
Limit Maximum number of document resources to be returned in a single page of results.
Page The page number of the document list to be returned, used for pagination.
Query Encoded SwagQL query in JSON format to filter or specify the documents to retrieve.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and request timeout.

Output

JSON

  • documents - Array of document objects retrieved from the Shopware API.

Dependencies

  • Shopware API with admin credentials

Troubleshooting

  • Ensure the API credentials are correctly configured and have permission to access document resources.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If using custom queries, verify the SwagQL JSON syntax is correct to avoid query errors.
  • SSL certificate errors can be bypassed by enabling the 'Ignore SSL Issues' option, but use with caution.

Links

Discussion