Shopware icon

Shopware

Shopware

Actions778

Theme → Update Theme

AI-generated

Overview

This node operation updates an existing Theme resource in the Shopware system. It allows users to modify various attributes of a theme such as its name, author, description, labels, media, and configuration details. This operation is useful for managing and customizing themes programmatically, for example, updating the theme's appearance or metadata in an automated workflow.

Use Case Examples

  1. Updating the name and author of a theme to reflect new branding.
  2. Modifying the theme's JSON configuration to change layout or style settings.
  3. Adding or updating media associated with the theme, such as preview images or dependent media files.

Properties

Name Meaning
Id Identifier for the theme, required to specify which theme to update.
Response Data format for response, used to specify the response format if needed.
Technical Name Technical identifier for the theme, used internally.
Name The display name of the theme.
Author The author of the theme.
Description Description of the theme.
Labels JSON object containing labels for the theme.
Help Texts JSON object containing help texts related to the theme.
Custom Fields JSON object for custom fields associated with the theme.
Preview Media Id Identifier for the preview media associated with the theme.
Parent Theme Id Identifier for the parent theme if this theme inherits from another.
Theme Json JSON object representing the theme's configuration and structure.
Base Config JSON object for the base configuration of the theme.
Config Values JSON object for configuration values of the theme.
Active Boolean flag indicating if the theme is active.
Created At Timestamp for when the theme was created.
Updated At Timestamp for when the theme was last updated.
Translated JSON object containing translated fields for the theme.
Sales Channels JSON array representing sales channels associated with the theme.
Media JSON array of media objects associated with the theme.
Preview Media JSON object representing the preview media details for the theme.
Dependent Themes JSON array of themes that depend on this theme.

Output

JSON

  • id - The unique identifier of the updated theme.
  • technicalName - The technical name of the updated theme.
  • name - The display name of the updated theme.
  • author - The author of the updated theme.
  • description - The description of the updated theme.
  • labels - Labels associated with the updated theme.
  • helpTexts - Help texts related to the updated theme.
  • customFields - Custom fields of the updated theme.
  • previewMediaId - Identifier for the preview media of the updated theme.
  • parentThemeId - Identifier for the parent theme of the updated theme.
  • themeJson - JSON configuration of the updated theme.
  • baseConfig - Base configuration of the updated theme.
  • configValues - Configuration values of the updated theme.
  • active - Indicates if the updated theme is active.
  • createdAt - Creation timestamp of the updated theme.
  • updatedAt - Last update timestamp of the updated theme.
  • translated - Translated fields of the updated theme.
  • salesChannels - Sales channels associated with the updated theme.
  • media - Media associated with the updated theme.
  • previewMedia - Preview media details of the updated theme.
  • dependentThemes - Themes that depend on the updated theme.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the 'Id' property is correctly set to the theme you want to update; otherwise, the update will fail.
  • Verify that JSON fields (e.g., labels, helpTexts, customFields, themeJson) are properly formatted JSON strings to avoid parsing errors.
  • Check API credentials and permissions to ensure the node can perform update operations on themes.
  • If the update fails, review the error message for details such as invalid fields or missing required properties and correct accordingly.

Discussion