Shopware icon

Shopware

Shopware

Actions778

Order Transaction Capture Refund → Update Order Transaction Capture Refund

AI-generated

Overview

This node updates an existing Order Transaction Capture Refund in the Shopware system. It is useful for scenarios where you need to modify details of a refund related to an order transaction capture, such as changing the refund amount, state, or adding custom fields. For example, it can be used to update the refund state after a customer service interaction or to correct refund details.

Use Case Examples

  1. Updating the refund amount and state for a specific order transaction capture refund.
  2. Adding an external reference or reason to an existing refund record.

Properties

Name Meaning
Id Identifier for the order_transaction_capture_refund, used to specify which refund to update.
_response Data format for the response, used to specify the desired response format from the API.
Version Id Version identifier for concurrency control when updating the refund.
Capture Id Identifier for the capture associated with the refund.
Capture Version Id Version identifier for the capture, used for concurrency control.
State Id Identifier for the state of the refund, indicating its current status.
External Reference An external reference string for the refund, useful for linking to external systems.
Reason Reason for the refund, providing context or explanation.
Amount The amount details of the refund, including list price and regulation price, specified as JSON.
Custom Fields Custom fields for additional data related to the refund, specified as JSON.
Created At Timestamp for when the refund was created.
Updated At Timestamp for when the refund was last updated.
State Machine State The state machine state object representing the state transitions and related data for the refund, specified as JSON.
Transaction Capture The transaction capture object related to the refund, including amounts and state machine state, specified as JSON.
Positions Positions related to the refund, detailing amounts and order line items, specified as JSON.

Output

JSON

  • id - Identifier of the updated order transaction capture refund.
  • versionId - Version identifier after update.
  • captureId - Identifier of the associated capture.
  • captureVersionId - Version identifier of the capture.
  • stateId - Current state identifier of the refund.
  • externalReference - External reference string of the refund.
  • reason - Reason for the refund.
  • amount - Amount details of the refund.
  • customFields - Custom fields data of the refund.
  • createdAt - Creation timestamp of the refund.
  • updatedAt - Last update timestamp of the refund.
  • stateMachineState - State machine state object of the refund.
  • transactionCapture - Transaction capture object related to the refund.
  • positions - Positions related to the refund.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure all required fields (Id, Capture Id, State Id, Amount) are provided to avoid validation errors.
  • Verify that the versionId matches the current version of the refund to prevent concurrency conflicts.
  • Check the JSON format for fields like amount, customFields, stateMachineState, transactionCapture, and positions to avoid parsing errors.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option or configure a proper proxy if needed.

Discussion