Shopware icon

Shopware

Shopware

Actions778

Order Transaction Capture → Update Order Transaction Capture

AI-generated

Overview

This node updates an existing Order Transaction Capture in the Shopware system. It is useful for scenarios where you need to modify details of a transaction capture related to an order, such as updating the amount, state, or related transaction information. For example, it can be used to adjust captured payment amounts or update the state of a transaction capture after a refund or correction.

Use Case Examples

  1. Updating the amount and state of an order transaction capture after a partial refund.
  2. Modifying the external reference or custom fields of a transaction capture for tracking purposes.

Properties

Name Meaning
Id Identifier for the order_transaction_capture, used to specify which capture to update.
Response Data format for the response, used as a query parameter to control the response format.
Version Id Version identifier for the order transaction capture, used for concurrency control.
Order Transaction Id Identifier of the related order transaction, required to link the capture to the correct transaction.
Order Transaction Version Id Version identifier for the order transaction, used for concurrency control.
State Id Identifier of the state to set for the transaction capture, representing its current status.
External Reference External reference string for the transaction capture, useful for integration or tracking.
Amount JSON object representing the amount details of the capture, including list price and regulation price.
Custom Fields JSON object for any custom fields to be added or updated on the transaction capture.
Created At Timestamp string indicating when the capture was created.
Updated At Timestamp string indicating when the capture was last updated.
State Machine State JSON object representing the state machine state of the capture, including transitions and related entities.
Transaction JSON object representing the transaction details related to the capture, including amounts, states, and related orders.
Refunds JSON array representing refunds associated with the transaction capture, including amounts and states.

Output

JSON

  • id - Identifier of the updated order transaction capture.
  • orderTransactionId - Identifier of the related order transaction.
  • stateId - Current state identifier of the transaction capture.
  • amount - Amount details of the transaction capture.
  • externalReference - External reference string of the transaction capture.
  • createdAt - Creation timestamp of the transaction capture.
  • updatedAt - Last update timestamp of the transaction capture.
  • stateMachineState - State machine state details of the transaction capture.
  • transaction - Transaction details related to the capture.
  • refunds - Refunds associated with the transaction capture.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure all required fields (Id, Order Transaction Id, State Id, Amount) are provided to avoid validation errors.
  • Check that JSON fields (Amount, Custom Fields, State Machine State, Transaction, Refunds) are correctly formatted to prevent parsing errors.
  • Verify API credentials and base URL configuration to avoid authentication or connection issues.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option in request settings.

Discussion