Shopware icon

Shopware

Shopware

Actions778

Cms Slot → Update Cms Slot

AI-generated

Overview

This node updates a CMS Slot in the Shopware system. It is useful for scenarios where you need to modify the content or configuration of a specific CMS Slot, such as changing its type, slot name, or associated block. Practical examples include updating the slot's configuration JSON, custom fields, or linked block information to reflect changes in the website's content management system.

Use Case Examples

  1. Updating the 'type' and 'slot' fields of a CMS Slot to change its display on a webpage.
  2. Modifying the 'config' JSON to adjust the slot's settings dynamically.
  3. Changing the 'blockId' or 'cmsBlockVersionId' to associate the slot with a different block version.

Properties

Name Meaning
Id Identifier for the CMS Slot to update, required to specify which slot to modify.
Response Data format for the response, used to specify how the response data should be formatted or filtered.
Version Id Version identifier for the CMS Slot, used to specify the version of the slot being updated.
Type Type of the CMS Slot, required to define the slot's content type.
Slot Name of the slot, required to specify the slot's identifier within the block.
Locked Boolean flag indicating if the slot is locked, controlling whether it can be edited.
Config JSON configuration object for the slot, allowing detailed customization of slot settings.
Custom Fields JSON object for custom fields, enabling additional metadata or custom data storage.
Data JSON object containing the slot's data content.
Block Id Identifier of the block to which the slot belongs, required to associate the slot with a block.
Field Config JSON object for field configuration, specifying additional field-level settings.
Cms Block Version Id Version identifier for the CMS Block, used to specify the block version associated with the slot.
Created At Timestamp string indicating when the slot was created.
Updated At Timestamp string indicating when the slot was last updated.
Translated JSON object containing translated content for the slot.
Block JSON object representing the block details associated with the slot, including nested visibility, sections, pages, and related entities.

Output

JSON

  • id - The unique identifier of the updated CMS Slot.
  • type - The type of the CMS Slot after update.
  • slot - The slot name or identifier after update.
  • locked - Boolean indicating if the slot is locked.
  • config - Configuration details of the slot in JSON format.
  • customFields - Custom fields associated with the slot in JSON format.
  • data - Data content of the slot in JSON format.
  • blockId - Identifier of the block the slot belongs to.
  • fieldConfig - Field configuration details in JSON format.
  • cmsBlockVersionId - Version ID of the CMS block associated with the slot.
  • createdAt - Creation timestamp of the slot.
  • updatedAt - Last update timestamp of the slot.
  • translated - Translated content of the slot in JSON format.
  • block - Detailed block information associated with the slot in JSON format.

Dependencies

  • An API key credential for Shopware Admin API authentication

Troubleshooting

  • Ensure the 'Id' property is correctly set to the CMS Slot you want to update; otherwise, the update will fail or affect the wrong slot.
  • Verify that JSON fields like 'config', 'customFields', 'data', 'fieldConfig', 'translated', and 'block' are valid JSON strings to avoid parsing errors.
  • Check API credentials and base URL configuration to ensure successful connection to the Shopware Admin API.
  • If the slot is locked ('locked' property is true), updates might be restricted depending on Shopware's permissions settings.

Discussion