Shopware icon

Shopware

Shopware

Actions778

Cms Page → Update Cms Page

AI-generated

Overview

This node operation updates an existing CMS Page in the Shopware system. It allows users to modify various attributes of a CMS Page such as its ID, version, name, type, entity, CSS class, configuration, preview media, custom fields, lock status, timestamps, translations, sections, categories, landing pages, home sales channels, and associated products. This operation is useful for managing and customizing the content and structure of CMS Pages dynamically within workflows, for example, updating page content or metadata based on external inputs or triggers.

Use Case Examples

  1. Updating the name and type of a CMS Page identified by its ID.
  2. Modifying the sections and preview media of a CMS Page to reflect new design changes.
  3. Setting custom fields and locking the CMS Page to prevent further edits.

Properties

Name Meaning
Id Identifier for the cms_page, required to specify which CMS Page to update.
Response Data format for response; optional query parameter to specify response format.
Version Id Version identifier of the CMS Page to update.
Name Name of the CMS Page.
Type Type of the CMS Page, required field.
Entity Entity associated with the CMS Page.
Css Class CSS class to apply to the CMS Page.
Config JSON configuration object for the CMS Page.
Preview Media Id Identifier for the preview media associated with the CMS Page.
Custom Fields Custom fields in JSON format for additional data.
Locked Boolean flag indicating if the CMS Page is locked.
Created At Timestamp for when the CMS Page was created.
Updated At Timestamp for when the CMS Page was last updated.
Translated JSON object containing translations for the CMS Page.
Sections JSON array defining the sections of the CMS Page.
Preview Media JSON object defining the preview media details of the CMS Page.
Categories JSON array defining categories associated with the CMS Page.
Landing Pages JSON array defining landing pages associated with the CMS Page.
Home Sales Channels JSON array defining home sales channels associated with the CMS Page.
Products JSON array defining products associated with the CMS Page.

Output

JSON

  • id - Identifier of the updated CMS Page.
  • versionId - Version identifier of the updated CMS Page.
  • name - Name of the updated CMS Page.
  • type - Type of the updated CMS Page.
  • entity - Entity associated with the updated CMS Page.
  • cssClass - CSS class applied to the updated CMS Page.
  • config - Configuration object of the updated CMS Page.
  • previewMediaId - Identifier of the preview media associated with the updated CMS Page.
  • customFields - Custom fields of the updated CMS Page.
  • locked - Lock status of the updated CMS Page.
  • createdAt - Creation timestamp of the updated CMS Page.
  • updatedAt - Last update timestamp of the updated CMS Page.
  • translated - Translations of the updated CMS Page.
  • sections - Sections of the updated CMS Page.
  • previewMedia - Preview media details of the updated CMS Page.
  • categories - Categories associated with the updated CMS Page.
  • landingPages - Landing pages associated with the updated CMS Page.
  • homeSalesChannels - Home sales channels associated with the updated CMS Page.
  • products - Products associated with the updated CMS Page.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the 'Id' and 'Type' fields are provided as they are required for the update operation.
  • Verify that JSON fields such as 'config', 'customFields', 'translated', 'sections', 'previewMedia', 'categories', 'landingPages', 'homeSalesChannels', and 'products' are correctly formatted JSON strings to avoid parsing errors.
  • Check API credentials and base URL configuration to ensure connectivity to the Shopware Admin API.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option in request settings if appropriate for your environment.

Discussion