Shopware icon

Shopware

Shopware

Actions778

Document Base Config → Update Document Base Config

AI-generated

Overview

This node operation updates a Document Base Config in the Shopware system. It is useful for scenarios where you need to modify existing document base configurations, such as changing the document type, logo, name, or other related settings. For example, updating the filename prefix or suffix, adjusting the global flag, or modifying custom fields and sales channels associated with the document base config.

Use Case Examples

  1. Updating the name and logo of a document base config to reflect a new branding.
  2. Changing the document type ID and associated sales channels for a document base config.
  3. Modifying custom fields and configuration JSON for a document base config to customize document generation.

Properties

Name Meaning
Id Identifier for the document_base_config, required to specify which config to update.
Response Data format for response, used as a query parameter to specify response format.
Document Type Id Identifier for the document type associated with the config.
Logo Id Identifier for the logo associated with the document base config.
Name Name of the document base config.
Filename Prefix Prefix to be added to filenames generated by this config.
Filename Suffix Suffix to be added to filenames generated by this config.
Global Boolean flag indicating if the config is global.
Document Number Document number associated with the config.
Config JSON configuration object for the document base config.
Created At Timestamp when the config was created.
Custom Fields JSON object containing custom fields for the config.
Updated At Timestamp when the config was last updated.
Document Type JSON object representing the document type details.
Logo JSON object representing the logo details.
Sales Channels JSON array representing sales channels associated with the document base config.

Output

JSON

  • id - Identifier of the updated document base config.
  • documentTypeId - Identifier of the associated document type.
  • logoId - Identifier of the associated logo.
  • name - Name of the document base config.
  • filenamePrefix - Filename prefix used in the config.
  • filenameSuffix - Filename suffix used in the config.
  • global - Boolean indicating if the config is global.
  • documentNumber - Document number associated with the config.
  • config - Configuration JSON object of the document base config.
  • createdAt - Creation timestamp of the config.
  • customFields - Custom fields JSON object.
  • updatedAt - Last update timestamp of the config.
  • documentType - Document type details JSON object.
  • logo - Logo details JSON object.
  • salesChannels - Sales channels JSON array associated with the config.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the 'Id' property is correctly set to the existing document base config ID to avoid 'not found' errors.
  • Validate JSON format for 'config', 'customFields', 'documentType', 'logo', and 'salesChannels' properties to prevent parsing errors.
  • Check API credentials and base URL configuration to avoid authentication or connection issues.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option in request settings.

Discussion