Shopware icon

Shopware

Shopware

Actions778

Document Type → Create Document Type

AI-generated

Overview

This node operation allows users to create a new Document Type in the Shopware system. It is useful for scenarios where you need to define and add new document types programmatically, such as invoices, delivery notes, or other custom document categories. Users can specify various attributes of the document type, including its ID, name, technical name, timestamps, custom fields, translations, and related document configurations.

Use Case Examples

  1. Creating a new invoice document type with specific custom fields and translations.
  2. Adding a custom document type for internal use with associated document base configurations and sales channels.

Properties

Name Meaning
Response Data format for the response, either basic or detailed.
Id Unique identifier for the document type.
Name Name of the document type.
Technical Name Technical name used internally for the document type.
Created At Timestamp when the document type was created.
Updated At Timestamp when the document type was last updated.
Custom Fields Custom fields associated with the document type, provided as JSON.
Translated Translation data for the document type, provided as JSON.
Documents JSON array representing documents related to the document type.
Document Base Configs JSON array representing base configurations for the document type.
Document Base Config Sales Channels JSON array representing sales channels associated with the document base configurations.

Output

JSON

  • id - Unique identifier of the created document type.
  • name - Name of the created document type.
  • technicalName - Technical name of the created document type.
  • createdAt - Creation timestamp of the document type.
  • updatedAt - Last update timestamp of the document type.
  • customFields - Custom fields data of the document type.
  • translated - Translation data of the document type.
  • documents - Documents associated with the document type.
  • documentBaseConfigs - Base configurations related to the document type.
  • documentBaseConfigSalesChannels - Sales channels linked to the document base configurations.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure all required fields (Id, Name, Technical Name) are provided to avoid validation errors.
  • Check JSON formatting for fields like Custom Fields, Translated, Documents, Document Base Configs, and Document Base Config Sales Channels to prevent parsing errors.
  • Verify 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