Shopware icon

Shopware

Shopware

Actions778

Cms Section → Update Cms Section

AI-generated

Overview

This node operation updates a CMS Section in a Shopware system. It is useful for modifying existing CMS sections by changing their properties such as position, type, name, background media, visibility, and other configuration details. For example, it can be used to update the layout or content of a section on a CMS page programmatically within an automation workflow.

Use Case Examples

  1. Updating the position and type of a CMS section to reorganize page layout.
  2. Changing the background color and media of a CMS section to refresh the visual appearance.
  3. Modifying visibility settings and custom fields of a CMS section to control its display and behavior.

Properties

Name Meaning
Id Identifier for the cms_section, used to specify which section to update.
Response Data format for response, used to specify the response format if needed.
Position Position of the CMS section, used to set the order of the section on the page.
Type Type of the CMS section, used to define the section's content type or layout.
Locked Boolean flag indicating if the section is locked, controlling editability.
Name Name of the CMS section, used for identification or labeling.
Sizing Mode Sizing mode of the section, controlling how it scales or fits in the layout.
Mobile Behavior Behavior of the section on mobile devices, controlling responsiveness.
Background Color Background color of the section, used for visual styling.
Background Media Id Identifier for background media, linking to media assets.
Background Media Mode Mode for displaying background media, controlling its presentation.
Css Class CSS class applied to the section, for custom styling.
Page Id Identifier of the page the section belongs to.
Visibility Visibility settings of the section, controlling when and where it is shown.
Custom Fields Custom fields for additional data or metadata.
Version Id Version identifier for the section, useful for version control.
Cms Page Version Id Version identifier for the CMS page the section belongs to.
Created At Creation timestamp of the section.
Updated At Last update timestamp of the section.
Page JSON object representing the page configuration and nested sections.
Background Media JSON object representing the background media details.
Blocks JSON array representing blocks within the CMS section.

Output

JSON

  • id - Identifier of the updated CMS section.
  • position - Position of the updated CMS section.
  • type - Type of the updated CMS section.
  • locked - Lock status of the updated CMS section.
  • name - Name of the updated CMS section.
  • sizingMode - Sizing mode of the updated CMS section.
  • mobileBehavior - Mobile behavior setting of the updated CMS section.
  • backgroundColor - Background color of the updated CMS section.
  • backgroundMediaId - Background media identifier of the updated CMS section.
  • backgroundMediaMode - Background media mode of the updated CMS section.
  • cssClass - CSS class of the updated CMS section.
  • pageId - Page identifier the updated CMS section belongs to.
  • visibility - Visibility settings of the updated CMS section.
  • customFields - Custom fields of the updated CMS section.
  • versionId - Version identifier of the updated CMS section.
  • cmsPageVersionId - CMS page version identifier of the updated CMS section.
  • createdAt - Creation timestamp of the updated CMS section.
  • updatedAt - Last update timestamp of the updated CMS section.
  • page - Page configuration JSON of the updated CMS section.
  • backgroundMedia - Background media JSON of the updated CMS section.
  • blocks - Blocks JSON array within the updated CMS section.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the 'Id' property is correctly set to the existing CMS section identifier to avoid 'not found' errors.
  • Validate JSON format for properties 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.
  • Timeouts or SSL issues can be configured in 'Request Options' to handle network-related errors.

Discussion