Shopware icon

Shopware

Shopware

Actions778

Document → Delete Document

AI-generated

Overview

This node operation deletes a document identified by its unique Id from the Shopware system. It is useful in scenarios where you need to programmatically remove documents, such as invoices or delivery notes, from your Shopware store. For example, you might use this node to automate cleanup of outdated or incorrect documents.

Use Case Examples

  1. Deleting a specific invoice document by its Id to maintain accurate records.
  2. Removing delivery notes that are no longer needed after order completion.

Properties

Name Meaning
Id Identifier for the document to be deleted, required to specify which document to remove.
Response Data format for the response from the delete operation, can be left empty if no response is needed.
Request Options Additional settings for the HTTP request such as batching, SSL certificate validation, proxy configuration, and timeout settings.

Output

JSON

  • id - The identifier of the deleted document.
  • status - Status of the delete operation, indicating success or failure.
  • message - Additional information or error message related to the delete operation.

Dependencies

  • Requires an API key credential for Shopware Admin API authentication.

Troubleshooting

  • Ensure the document Id provided is correct and exists in the Shopware system to avoid 'document not found' errors.
  • Check network connectivity and proxy settings if requests fail to reach the Shopware server.
  • If SSL certificate validation fails, consider enabling the 'Ignore SSL Issues' option, but be aware of security risks.
  • Timeout errors can occur if the server is slow to respond; adjust the timeout setting accordingly.

Discussion