Shopware icon

Shopware

Shopware

Actions778

Document Base Config Sales Channel → Create Document Base Config Sales Channel

AI-generated

Overview

This node operation creates a new Document Base Config Sales Channel in the Shopware system. It is useful for automating the configuration of sales channels related to document base settings, such as linking document base configurations with specific sales channels and document types. Practical examples include setting up new sales channels with predefined document configurations for invoices, delivery notes, or other document types in an e-commerce platform.

Use Case Examples

  1. Automatically create a sales channel configuration for document handling when onboarding a new sales channel.
  2. Integrate with other systems to dynamically update document base configurations for sales channels based on business rules.

Properties

Name Meaning
Response Specifies the data format for the response, either basic or detailed.
Id Unique identifier for the Document Base Config Sales Channel entry.
Document Base Config Id Identifier for the associated Document Base Config.
Sales Channel Id Identifier for the Sales Channel to link.
Document Type Id Identifier for the Document Type associated with the configuration.
Created At Timestamp for when the configuration was created.
Updated At Timestamp for when the configuration was last updated.
Document Type JSON object representing the Document Type details and related nested data.
Document Base Config JSON object representing the Document Base Config details and related nested data.
Sales Channel JSON object representing the Sales Channel details and related nested data.

Output

JSON

  • id - Unique identifier of the created Document Base Config Sales Channel.
  • documentBaseConfigId - Identifier of the associated Document Base Config.
  • salesChannelId - Identifier of the linked Sales Channel.
  • documentTypeId - Identifier of the associated Document Type.
  • createdAt - Creation timestamp of the configuration.
  • updatedAt - Last update timestamp of the configuration.
  • documentType - Detailed JSON object of the Document Type.
  • documentBaseConfig - Detailed JSON object of the Document Base Config.
  • salesChannel - Detailed JSON object of the Sales Channel.

Dependencies

  • An API key credential for Shopware Admin API authentication.

Troubleshooting

  • Ensure all required fields (Id, Document Base Config Id) are provided to avoid validation errors.
  • Verify JSON format correctness for Document Type, Document Base Config, and Sales Channel fields to prevent parsing errors.
  • Check API credentials and endpoint URL configuration if authentication or connection errors occur.

Discussion