Shopware icon

Shopware

Shopware

Actions778

Document Management → Download Document

AI-generated

Overview

This node operation allows users to download a document from a document management system by specifying the document's unique identifier and a deep link code. It supports controlling the content disposition header to either prompt a download or display the document inline. This is useful in scenarios where automated workflows need to retrieve documents for processing, archiving, or user access.

Use Case Examples

  1. Automatically download invoices or reports from a document management system for further processing.
  2. Retrieve and display documents inline within a web application or workflow.
  3. Batch download multiple documents by integrating with other nodes and using batching options.

Properties

Name Meaning
Document Id Identifier of the document to be downloaded.
Deep Link Code A unique hash code generated when the document was created, used for secure access.
Download Controls the Content-Disposition header; if true, the document is downloaded as an attachment, otherwise displayed inline.
Request Options Additional request settings such as batching, SSL certificate validation, proxy, and timeout options.

Output

JSON

  • documentId - The identifier of the downloaded document.
  • content - The content of the downloaded document, typically as a binary or base64 encoded string.
  • contentDisposition - Indicates if the content was downloaded as an attachment or displayed inline based on the 'Download' property.

Dependencies

  • An API key credential for authenticating with the document management system.

Troubleshooting

  • Ensure the Document Id and Deep Link Code are correct and valid; invalid values will cause download failures.
  • If SSL certificate validation fails and 'Ignore SSL Issues' is not enabled, the request will be blocked.
  • Proxy settings must be correctly configured if used; incorrect proxy details can cause connection failures.
  • Timeout settings should be adjusted based on network conditions to avoid premature request abortion.

Discussion