Shopware icon

Shopware

Shopware

Actions778

Plugin → Update Plugin

AI-generated

Overview

This node operation updates a Plugin resource in the Shopware system. It allows users to modify various attributes of a plugin such as its identifier, name, version, author, license, activation status, and other metadata. This operation is useful for managing and maintaining plugins within a Shopware environment, ensuring that plugin details are current and correctly configured.

Use Case Examples

  1. Updating the version and activation status of a plugin after a new release.
  2. Modifying the author or license information of a plugin for compliance or documentation purposes.
  3. Changing the plugin's base class or autoload configuration to adjust its behavior within Shopware.

Properties

Name Meaning
Id Identifier for the plugin, required to specify which plugin to update.
Response Data format for the response, optional query parameter to control response format.
Base Class The base class of the plugin, required for update.
Name The name of the plugin, required for update.
Composer Name Composer package name of the plugin, optional.
Autoload Autoload configuration for the plugin, required and parsed from JSON.
Active Boolean flag indicating if the plugin is active.
Managed By Composer Boolean flag indicating if the plugin is managed by Composer.
Path File system path of the plugin, optional.
Author Author of the plugin, optional.
Copyright Copyright information for the plugin, optional.
License License information for the plugin, optional.
Version Version of the plugin, required for update.
Upgrade Version Version to upgrade the plugin to, optional.
Installed At Timestamp when the plugin was installed, optional.
Upgraded At Timestamp when the plugin was last upgraded, optional.
Icon Icon representing the plugin, optional runtime field.
Label Label for the plugin, required for update.
Description Description of the plugin, optional.
Manufacturer Link URL link to the manufacturer, optional.
Support Link URL link to support resources, optional.
Custom Fields Custom fields in JSON format for additional plugin metadata.
Created At Timestamp when the plugin was created, optional.
Updated At Timestamp when the plugin was last updated, optional.
Translated Translated fields in JSON format for localization.
Payment Methods Payment methods associated with the plugin, provided as JSON.
Request Options Node settings for request handling such as batching, SSL, proxy, and timeout.

Output

JSON

  • id - Identifier of the updated plugin.
  • baseClass - Base class of the updated plugin.
  • name - Name of the updated plugin.
  • composerName - Composer package name of the updated plugin.
  • autoload - Autoload configuration of the updated plugin.
  • active - Activation status of the updated plugin.
  • managedByComposer - Composer management status of the updated plugin.
  • path - File system path of the updated plugin.
  • author - Author of the updated plugin.
  • copyright - Copyright information of the updated plugin.
  • license - License information of the updated plugin.
  • version - Version of the updated plugin.
  • upgradeVersion - Upgrade version of the updated plugin.
  • installedAt - Installation timestamp of the updated plugin.
  • upgradedAt - Last upgrade timestamp of the updated plugin.
  • icon - Icon representing the updated plugin.
  • label - Label of the updated plugin.
  • description - Description of the updated plugin.
  • manufacturerLink - Manufacturer URL link of the updated plugin.
  • supportLink - Support URL link of the updated plugin.
  • customFields - Custom fields metadata of the updated plugin.
  • createdAt - Creation timestamp of the updated plugin.
  • updatedAt - Last update timestamp of the updated plugin.
  • translated - Localized translated fields of the updated plugin.
  • paymentMethods - Payment methods associated with the updated plugin.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure all required fields (Id, Base Class, Name, Autoload, Version, Label) are provided to avoid validation errors.
  • If the autoload, customFields, translated, or paymentMethods fields are provided as JSON strings, ensure they are valid JSON to prevent parsing errors.
  • Check network connectivity and API credentials if requests fail or time out.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option if appropriate.

Discussion