Shopware icon

Shopware

Shopware

Actions778

Cms Section → Create Cms Section

AI-generated

Overview

This node operation creates a CMS Section in a Shopware system. It is useful for automating the addition of content sections to CMS pages, allowing users to define various attributes of the section such as its ID, position, type, locking status, name, sizing mode, mobile behavior, background color and media, CSS class, page association, visibility, custom fields, versioning, and timestamps. This operation supports detailed customization of the CMS Section's content blocks and background media, enabling complex page layouts to be programmatically managed.

Use Case Examples

  1. Automatically create a new CMS Section with specific layout and content blocks for a marketing page.
  2. Add a locked CMS Section with custom background media and visibility settings to a product landing page.

Properties

Name Meaning
Response Data format for response, either basic or detailed.
Id Unique identifier for the CMS Section.
Position Position of the CMS Section on the page.
Type Type of the CMS Section.
Locked Indicates if the CMS Section is locked.
Name Name of the CMS Section.
Sizing Mode Sizing mode of the CMS Section.
Mobile Behavior Mobile behavior settings for the CMS Section.
Background Color Background color of the CMS Section.
Background Media Id Identifier for the background media.
Background Media Mode Mode for the background media.
Css Class CSS class applied to the CMS Section.
Page Id Identifier of the page to which the CMS Section belongs.
Visibility Visibility settings for the CMS Section.
Custom Fields Custom fields for additional data.
Version Id Version identifier for the CMS Section.
Cms Page Version Id CMS page version identifier.
Created At Creation timestamp of the CMS Section.
Updated At Update timestamp of the CMS Section.
Page JSON object representing the page configuration and nested sections.
Background Media JSON object representing the background media details.
Blocks JSON array representing the content blocks within the CMS Section.

Output

JSON

  • id - Unique identifier of the created CMS Section.
  • position - Position of the CMS Section on the page.
  • type - Type of the CMS Section.
  • locked - Lock status of the CMS Section.
  • name - Name of the CMS Section.
  • sizingMode - Sizing mode of the CMS Section.
  • mobileBehavior - Mobile behavior settings.
  • backgroundColor - Background color of the CMS Section.
  • backgroundMediaId - Identifier for the background media.
  • backgroundMediaMode - Mode for the background media.
  • cssClass - CSS class applied to the CMS Section.
  • pageId - Identifier of the associated page.
  • visibility - Visibility settings.
  • customFields - Custom fields data.
  • versionId - Version identifier.
  • cmsPageVersionId - CMS page version identifier.
  • createdAt - Creation timestamp.
  • updatedAt - Update timestamp.
  • page - Page configuration JSON object.
  • backgroundMedia - Background media JSON object.
  • blocks - Content blocks JSON array.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure all required fields (Id, Position, Type, Page Id) are provided to avoid validation errors.
  • Verify the JSON format for complex fields like Visibility, Custom Fields, Page, Background Media, and Blocks to prevent parsing errors.
  • Check API credentials and base URL configuration to ensure successful authentication and connection to the Shopware instance.

Discussion