Shopware icon

Shopware

Shopware

Actions778

Document Base Config → Create Document Base Config

AI-generated

Overview

This node operation creates a new Document Base Config in the Shopware system. It is useful for automating the setup of document configurations such as invoices, delivery notes, or other document templates within Shopware. Users can specify details like document type, logo, sales channels, naming conventions, and custom fields to tailor the document base configuration to their needs.

Use Case Examples

  1. Automatically create a new invoice template configuration when onboarding a new sales channel.
  2. Set up custom document base configurations for different document types with specific logos and naming conventions.

Properties

Name Meaning
Response Data format for the response, either basic or detailed.
Id Unique identifier for the document base config.
Document Type Id Identifier for the type of document this config applies to.
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 the filename of generated documents.
Filename Suffix Suffix to be added to the filename of generated documents.
Global Boolean flag indicating if the config is global.
Document Number Document number associated with the config.
Config JSON object containing additional configuration details.
Created At Timestamp of when the config was created.
Custom Fields JSON object for custom fields to extend the config.
Updated At Timestamp of the last update to the config.
Document Type JSON object representing the document type details.
Logo JSON object representing the logo details.
Sales Channels JSON array representing the sales channels associated with the config.

Output

JSON

  • id - Unique identifier of the created document base config.
  • documentTypeId - Identifier of the document type associated with the config.
  • logoId - Identifier of the logo associated with the config.
  • name - Name of the document base config.
  • filenamePrefix - Prefix added to filenames of generated documents.
  • filenameSuffix - Suffix added to filenames of generated documents.
  • global - Boolean indicating if the config is global.
  • documentNumber - Document number associated with the config.
  • config - Additional configuration details as a JSON object.
  • createdAt - Creation timestamp of the config.
  • customFields - Custom fields as a JSON object for extending the config.
  • updatedAt - Timestamp of the last update to the config.
  • documentType - Details of the document type as a JSON object.
  • logo - Details of the logo as a JSON object.
  • salesChannels - Sales channels associated with the config as a JSON array.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure all required fields (Id, Document Type Id, Name) are provided to avoid validation errors.
  • If the API returns authentication errors, verify the Shopware Admin API credentials are correctly configured.
  • For JSON fields (config, customFields, documentType, logo, salesChannels), ensure valid JSON syntax to prevent parsing errors.
  • Timeout or network errors can occur if the Shopware server is unreachable or slow; check network connectivity and proxy settings if used.

Discussion