Shopware icon

Shopware

Shopware

Actions778

Payment Method → Update Payment Method

AI-generated

Overview

This node operation updates an existing Payment Method in the Shopware system. It allows users to modify various attributes of a payment method such as its name, description, active status, position, and associated plugin details. This operation is useful for managing payment options dynamically within an e-commerce platform, ensuring that payment methods are kept current and aligned with business needs.

Use Case Examples

  1. Updating the name and description of a payment method to reflect a new branding.
  2. Activating or deactivating a payment method based on availability or business rules.
  3. Changing the position of a payment method to reorder how it appears to customers during checkout.

Properties

Name Meaning
Id Identifier for the payment_method, required to specify which payment method to update.
Response Data format for response. Empty if none is provided.
Plugin Id Identifier for the plugin associated with the payment method.
Handler Identifier Identifier for the handler managing the payment method.
Name Name of the payment method, required for update.
Distinguishable Name A distinguishable name for the payment method.
Description Description of the payment method.
Position Position of the payment method in the list or UI.
Active Boolean flag indicating if the payment method is active.
After Order Enabled Boolean flag indicating if the payment method is enabled after order placement.
Custom Fields Custom JSON fields for additional data.
Availability Rule Id Identifier for the availability rule governing the payment method.
Media Id Identifier for media associated with the payment method.
Formatted Handler Identifier Runtime field, cannot be used as part of the criteria.
Synchronous Runtime boolean field indicating if the payment method is synchronous.
Asynchronous Runtime boolean field indicating if the payment method is asynchronous.
Prepared Runtime boolean field indicating if the payment method is prepared.
Refundable Runtime boolean field indicating if the payment method is refundable.
Recurring Runtime boolean field indicating if the payment method supports recurring payments.
Short Name Runtime field for a short name of the payment method.
Technical Name Technical name of the payment method.
Created At Creation timestamp of the payment method.
Updated At Last update timestamp of the payment method.
Translated Translated fields in JSON format.
Media Media information in JSON format associated with the payment method.
Availability Rule Availability rule in JSON format governing the payment method.
Sales Channel Default Assignments JSON array of sales channel default assignments.
Plugin Plugin information in JSON format associated with the payment method.
Customers JSON array of customers associated with the payment method.
Order Transactions JSON array of order transactions related to the payment method.
Sales Channels JSON array of sales channels associated with the payment method.
App Payment Method JSON object representing the app payment method details.

Output

JSON

  • id - Identifier of the updated payment method
  • name - Name of the updated payment method
  • active - Active status of the updated payment method
  • description - Description of the updated payment method
  • position - Position of the updated payment method
  • pluginId - Plugin identifier associated with the updated payment method
  • handlerIdentifier - Handler identifier of the updated payment method
  • distinguishableName - Distinguishable name of the updated payment method
  • afterOrderEnabled - Flag indicating if the payment method is enabled after order
  • customFields - Custom fields in JSON format
  • availabilityRuleId - Availability rule identifier
  • mediaId - Media identifier associated with the payment method
  • formattedHandlerIdentifier - Formatted handler identifier (runtime field)
  • synchronous - Indicates if the payment method is synchronous (runtime field)
  • asynchronous - Indicates if the payment method is asynchronous (runtime field)
  • prepared - Indicates if the payment method is prepared (runtime field)
  • refundable - Indicates if the payment method is refundable (runtime field)
  • recurring - Indicates if the payment method supports recurring payments (runtime field)
  • shortName - Short name of the payment method (runtime field)
  • technicalName - Technical name of the payment method
  • createdAt - Creation timestamp
  • updatedAt - Last update timestamp
  • translated - Translated fields in JSON format
  • media - Media information in JSON format
  • availabilityRule - Availability rule in JSON format
  • salesChannelDefaultAssignments - Sales channel default assignments in JSON format
  • plugin - Plugin information in JSON format
  • customers - Customers associated with the payment method in JSON format
  • orderTransactions - Order transactions related to the payment method in JSON format
  • salesChannels - Sales channels associated with the payment method in JSON format
  • appPaymentMethod - App payment method details in JSON format

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the 'Id' property is provided and correctly identifies an existing payment method to update.
  • Verify that JSON fields (e.g., customFields, translated, media) are properly formatted to avoid parsing errors.
  • Check API credentials and permissions to ensure the node can perform update operations on payment methods.
  • If the update fails, review the error message for details on missing required fields or invalid data formats.

Discussion