Shopware icon

Shopware

Shopware

Actions778

Sales Channel → Create Sales Channel

AI-generated

Overview

This node operation creates a new Sales Channel in the Shopware system. It allows users to specify detailed configuration for the sales channel, including identifiers, language, currency, payment and shipping methods, categories, and various other settings. This is useful for e-commerce platforms managing multiple sales channels with distinct configurations, enabling automation of sales channel creation with precise control over its properties.

Use Case Examples

  1. Creating a new online store sales channel with specific language, currency, and payment methods.
  2. Automating the setup of a sales channel for a new market region with localized settings and categories.

Properties

Name Meaning
Response Data format for response, either basic or detailed.
Id Unique identifier for the sales channel.
Type Id Identifier for the type of sales channel.
Language Id Identifier for the language used in the sales channel.
Customer Group Id Identifier for the customer group associated with the sales channel.
Currency Id Identifier for the currency used in the sales channel.
Payment Method Id Identifier for the default payment method.
Shipping Method Id Identifier for the default shipping method.
Country Id Identifier for the country associated with the sales channel.
Analytics Id Identifier for analytics configuration.
Navigation Category Id Identifier for the navigation category.
Navigation Category Version Id Version identifier for the navigation category.
Navigation Category Depth Depth level for the navigation category.
Footer Category Id Identifier for the footer category.
Footer Category Version Id Version identifier for the footer category.
Service Category Id Identifier for the service category.
Service Category Version Id Version identifier for the service category.
Mail Header Footer Id Identifier for mail header and footer configuration.
Hreflang Default Domain Id Identifier for the default domain used in hreflang tags.
Name Name of the sales channel.
Short Name Short name of the sales channel.
Tax Calculation Type Type of tax calculation used.
Access Key Access key for the sales channel.
Configuration JSON configuration object for the sales channel.
Active Boolean flag indicating if the sales channel is active.
Hreflang Active Boolean flag indicating if hreflang is active.
Maintenance Boolean flag indicating if maintenance mode is enabled.
Maintenance Ip Whitelist JSON array of IPs allowed during maintenance.
Custom Fields JSON object for custom fields.
Payment Method Ids JSON array of payment method identifiers.
Home Cms Page Id Identifier for the home CMS page.
Home Cms Page Version Id Version identifier for the home CMS page.
Home Slot Config JSON configuration for home page slots.
Home Enabled Boolean flag indicating if the home page is enabled.
Home Name Name of the home page.
Home Meta Title Meta title for the home page.
Home Meta Description Meta description for the home page.
Home Keywords Keywords for the home page.
Created At Creation timestamp.
Updated At Update timestamp.
Translated JSON object for translated fields.
Extensions JSON object for extensions.
Currencies JSON array of currencies associated with the sales channel.
Languages JSON array of languages associated with the sales channel.
Countries JSON array of countries associated with the sales channel.
Payment Methods JSON array of payment methods.
Shipping Methods JSON array of shipping methods.
Type JSON object describing the type of sales channel.
Language JSON object describing the language.
Customer Group JSON object describing the customer group.
Currency JSON object describing the currency.
Payment Method JSON object describing the payment method.
Shipping Method JSON object describing the shipping method.
Country JSON object describing the country.
Orders JSON array of orders associated with the sales channel.
Customers JSON array of customers associated with the sales channel.
Home Cms Page JSON object describing the home CMS page.
Domains JSON array of domains associated with the sales channel.
System Configs JSON array of system configurations.
Navigation Category JSON object describing the navigation category.
Footer Category JSON object describing the footer category.
Service Category JSON object describing the service category.
Product Visibilities JSON array of product visibility settings.
Hreflang Default Domain JSON object describing the default domain for hreflang.
Mail Header Footer JSON object describing mail header and footer settings.
Newsletter Recipients JSON array of newsletter recipients.
Number Range Sales Channels JSON array of number range sales channel settings.
Promotion Sales Channels JSON array of promotion sales channel settings.
Document Base Config Sales Channels JSON array of document base config sales channel settings.
Product Reviews JSON array of product reviews.
Customer Groups Registrations JSON array of customer group registrations.
Landing Pages JSON array of landing pages.
Bound Customers JSON array of bound customers.
Wishlists JSON array of wishlists.

Output

JSON

  • id - Unique identifier of the created sales channel
  • name - Name of the created sales channel
  • typeId - Type identifier of the sales channel
  • languageId - Language identifier of the sales channel
  • customerGroupId - Customer group identifier associated with the sales channel
  • currencyId - Currency identifier used in the sales channel
  • paymentMethodId - Default payment method identifier
  • shippingMethodId - Default shipping method identifier
  • countryId - Country identifier associated with the sales channel
  • active - Indicates if the sales channel is active
  • accessKey - Access key for the sales channel
  • configuration - Configuration object for the sales channel
  • createdAt - Timestamp when the sales channel was created
  • updatedAt - Timestamp when the sales channel was last updated
  • customFields - Custom fields associated with the sales channel
  • domains - Domains associated with the sales channel
  • languages - Languages associated with the sales channel
  • currencies - Currencies associated with the sales channel
  • paymentMethods - Payment methods associated with the sales channel
  • shippingMethods - Shipping methods associated with the sales channel
  • type - Type details of the sales channel
  • customerGroup - Customer group details
  • country - Country details
  • orders - Orders associated with the sales channel
  • customers - Customers associated with the sales channel
  • homeCmsPage - Home CMS page details
  • navigationCategory - Navigation category details
  • footerCategory - Footer category details
  • serviceCategory - Service category details
  • productVisibilities - Product visibility settings
  • hreflangDefaultDomain - Default domain for hreflang settings
  • mailHeaderFooter - Mail header and footer settings
  • newsletterRecipients - Newsletter recipients
  • numberRangeSalesChannels - Number range sales channel settings
  • promotionSalesChannels - Promotion sales channel settings
  • documentBaseConfigSalesChannels - Document base config sales channel settings
  • productReviews - Product reviews
  • customerGroupsRegistrations - Customer group registrations
  • landingPages - Landing pages
  • boundCustomers - Bound customers
  • wishlists - Wishlists

Troubleshooting

  • Ensure all required fields (marked as required) are provided with valid values.
  • Verify that JSON fields are correctly formatted and parsable.
  • Check API credentials and permissions to create sales channels.
  • If the API returns errors, review the error messages for missing or invalid data.

Discussion