Shopware icon

Shopware

Shopware

Actions778

Order Transaction Capture → Create Order Transaction Capture

AI-generated

Overview

This node operation creates an Order Transaction Capture in the Shopware system. It is useful for automating the capture of payment transactions related to orders, allowing users to specify detailed transaction and refund information, state machine states, and amounts. This operation is beneficial in e-commerce workflows where payment captures need to be programmatically managed and tracked.

Use Case Examples

  1. Automatically capture payment transactions for an order after a successful payment authorization.
  2. Create detailed transaction captures including refunds and state transitions for order processing automation.

Properties

Name Meaning
Response Specifies the data format for the response, either basic or detailed.
Id The unique identifier for the order transaction capture (required).
Version Id The version identifier for the order transaction capture.
Order Transaction Id The identifier of the order transaction to capture (required).
Order Transaction Version Id The version identifier of the order transaction to capture.
State Id The state identifier representing the capture state (required).
External Reference An external reference string for the capture.
Amount The amount details for the capture, including list price and regulation price (required).
Custom Fields Custom fields as JSON for additional data.
Created At The creation timestamp for the capture.
Updated At The update timestamp for the capture.
State Machine State The state machine state details as JSON, representing the state transitions and related order transaction data.
Transaction The transaction details as JSON, including amounts, state machine states, and related order data.
Refunds A JSON array of refund details related to the transaction capture.
Request Options Node-level request options such as batching, SSL handling, proxy, and timeout settings.

Output

JSON

  • id - The unique identifier of the created order transaction capture.
  • orderTransactionId - The identifier of the order transaction associated with the capture.
  • stateId - The state identifier representing the capture state.
  • amount - The amount details of the capture, including list price and regulation price.
  • transaction - The transaction details associated with the capture, including state and amounts.
  • refunds - The refunds related to the transaction capture, if any.
  • createdAt - The creation timestamp of the capture.
  • updatedAt - The update timestamp of the capture.
  • customFields - Any custom fields associated with the capture.
  • stateMachineState - The state machine state details representing the state transitions and related order transaction data.

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.
  • Verify that JSON fields (Amount, Custom Fields, State Machine State, Transaction, Refunds) are correctly formatted to prevent parsing errors.
  • Check API credentials and endpoint URL configuration to avoid authentication or connection issues.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option or configuring a proper proxy if needed.

Discussion