Shopware icon

Shopware

Shopware

Actions778

Order Transaction Capture Refund Position → Update Order Transaction Capture Refund Position

AI-generated

Overview

This node updates an existing Order Transaction Capture Refund Position in the Shopware system. It is useful for scenarios where you need to modify details of a refund position related to an order transaction capture, such as adjusting quantities, amounts, reasons, or custom fields. For example, it can be used to correct refund details after a customer service interaction or to update refund information based on new transaction data.

Use Case Examples

  1. Updating the quantity and amount of a refund position after a partial return.
  2. Modifying the reason or external reference for a refund position to reflect updated customer communication.

Properties

Name Meaning
Id Identifier for the order_transaction_capture_refund_position, required to specify which refund position to update.
_response Data format for the response, optional query parameter to specify response format.
Version Id Version identifier for concurrency control during update.
Refund Id Identifier of the refund associated with this refund position, required.
Refund Version Id Version identifier for the refund entity.
Order Line Item Id Identifier of the order line item related to this refund position, required.
Order Line Item Version Id Version identifier for the order line item.
External Reference External reference string for the refund position.
Reason Reason for the refund position.
Quantity Quantity of items to refund.
Amount Amount details for the refund position, including listPrice and regulationPrice, required.
Custom Fields Custom fields as JSON object for additional data.
Created At Timestamp when the refund position was created.
Updated At Timestamp when the refund position was last updated.
Order Line Item Detailed JSON object representing the order line item associated with the refund position.
Order Transaction Capture Refund Detailed JSON object representing the refund associated with the capture transaction.
Request Options Node settings for request options such as batching, SSL handling, proxy, and timeout.

Output

JSON

  • id - Identifier of the updated order transaction capture refund position.
  • refundId - Identifier of the associated refund.
  • orderLineItemId - Identifier of the associated order line item.
  • quantity - Quantity of items refunded.
  • amount
    • listPrice - List price amount details.
    • regulationPrice - Regulation price amount details.
  • reason - Reason for the refund.
  • externalReference - External reference string.
  • customFields - Custom fields data.
  • createdAt - Creation timestamp.
  • updatedAt - Last update timestamp.

Dependencies

  • Shopware Admin API with appropriate credentials

Troubleshooting

  • Ensure all required fields (Id, Refund Id, Order Line Item Id, Amount) are provided to avoid validation errors.
  • Check API credentials and base URL configuration to prevent authentication or connection issues.
  • If using batching, verify batch size and interval settings to avoid request throttling problems.
  • For SSL errors, consider enabling 'Ignore SSL Issues' if working with self-signed certificates.

Discussion