Shopware icon

Shopware

Shopware

Actions778

Document Management → Create Documents

AI-generated

Overview

This node operation creates documents within a document management system. It is useful for automating the creation of various document types, such as PDFs or other file formats, by specifying the document type and providing the document content or metadata in JSON format. Practical examples include generating invoices, reports, or reference documents programmatically.

Use Case Examples

  1. Creating a PDF invoice document by specifying 'pdf' as the fileType and providing invoice data in the body JSON.
  2. Creating a referenced document by specifying a referencedDocumentId in the body JSON to link to an existing document.

Properties

Name Meaning
Document Type Name Specifies the type of document to create, which is required to identify the document category or template.
Body Contains the JSON structure defining the document content and metadata, such as fileType, static flag, and referencedDocumentId. This JSON is parsed and sent as the request body.
Request Options Settings to control request behavior, including batching of requests, SSL certificate validation, proxy configuration, and request timeout.

Output

JSON

  • documentId - The unique identifier of the created document.
  • status - The status of the document creation operation, e.g., success or failure.
  • message - Additional information or error messages related to the document creation process.

Dependencies

  • An API key credential or authentication token for accessing the document management system's API.

Troubleshooting

  • Ensure the 'Document Type Name' is correctly specified and exists in the system to avoid errors.
  • Validate the JSON structure in the 'Body' property to prevent parsing errors or malformed requests.
  • Check network settings such as proxy and SSL options if requests fail due to connectivity or security issues.
  • Adjust batching settings if requests are throttled or delayed excessively.

Discussion