Shopware icon

Shopware

Shopware

Actions778

Document Type → Update Document Type

AI-generated

Overview

This node operation updates an existing Document Type in the Shopware system. It allows users to modify various attributes of a Document Type such as its identifier, name, technical name, timestamps, custom fields, translations, and associated documents and configurations. This operation is useful in scenarios where document metadata or configurations need to be changed or maintained programmatically within an automation workflow.

Use Case Examples

  1. Updating the name and technical name of a Document Type to reflect new business requirements.
  2. Modifying custom fields or translations of a Document Type to support localization or additional metadata.
  3. Adjusting associated documents or document base configurations linked to a Document Type for compliance or operational changes.

Properties

Name Meaning
Id Identifier for the document_type, used to specify which Document Type to update.
Response Data format for response; controls the response format returned by the API call.
Name The new name to assign to the Document Type.
Technical Name The new technical name to assign to the Document Type.
Created At Timestamp indicating when the Document Type was created.
Updated At Timestamp indicating when the Document Type was last updated.
Custom Fields Custom JSON fields to add or update on the Document Type.
Translated Translated fields in JSON format for localization support.
Documents JSON array representing documents associated with the Document Type.
Document Base Configs JSON array representing base configurations related to the Document Type.
Document Base Config Sales Channels JSON array representing sales channel configurations for the Document Base Configs.

Output

JSON

  • id - Identifier of the updated Document Type.
  • name - Name of the updated Document Type.
  • technicalName - Technical name of the updated Document Type.
  • createdAt - Creation timestamp of the Document Type.
  • updatedAt - Last update timestamp of the Document Type.
  • customFields - Custom fields associated with the Document Type.
  • translated - Translated fields for localization.
  • documents - Documents associated with the Document Type.
  • documentBaseConfigs - Base configurations related to the Document Type.
  • documentBaseConfigSalesChannels - Sales channel configurations for the Document Base Configs.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the 'Id' property is correctly set to the existing Document Type identifier to avoid 'not found' errors.
  • Validate JSON format for 'Custom Fields', 'Translated', 'Documents', 'Document Base Configs', and 'Document Base Config Sales Channels' to prevent parsing errors.
  • Check API credentials and permissions to ensure the node can update Document Types in Shopware.
  • Timeout or network issues may occur; adjust 'Timeout' and 'Proxy' settings in Request Options if needed.

Discussion