Shopware icon

Shopware

Shopware

Actions778

Order Transaction Capture Refund Position → Create Order Transaction Capture Refund Position

AI-generated

Overview

This node operation creates a new Order Transaction Capture Refund Position in the Shopware system. It is useful for automating the process of refunding specific positions within an order transaction capture, allowing precise control over refund details such as refund ID, order line item, quantity, amount, and custom fields. Practical examples include refunding a portion of an order due to a returned item or adjusting refund amounts based on specific business rules.

Use Case Examples

  1. Refunding a specific item in an order by specifying the order line item ID and refund details.
  2. Creating a refund position with detailed amount and reason for audit and tracking purposes.

Properties

Name Meaning
Response Data format for the response, either basic or detailed.
Id The unique identifier for the refund position.
Version Id The version identifier for the refund position.
Refund Id The identifier of the refund associated with this position.
Refund Version Id The version identifier of the refund.
Order Line Item Id The identifier of the order line item being refunded.
Order Line Item Version Id The version identifier of the order line item.
External Reference An external reference string for the refund position.
Reason The reason for the refund position.
Quantity The quantity of items to refund.
Amount The amount details for the refund, including list price and regulation price.
Custom Fields Custom fields for additional data related to the refund position.
Created At The creation timestamp of the refund position.
Updated At The last update timestamp of the refund position.
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 order transaction capture refund associated with the position.
Request Options Settings for request options such as batching, SSL issues, proxy, and timeout.

Output

JSON

  • id - The unique identifier of the created refund position.
  • refundId - The identifier of the refund associated with the created position.
  • orderLineItemId - The identifier of the order line item refunded.
  • quantity - The quantity refunded in the created position.
  • amount - The amount details of the refund position, including list and regulation prices.
  • reason - The reason provided for the refund position.
  • externalReference - An external reference string associated with the refund position.
  • createdAt - Timestamp when the refund position was created.
  • updatedAt - Timestamp when the refund position was last updated.
  • customFields - Custom fields data associated with the refund position.
  • orderLineItem - Detailed JSON object of the order line item related to the refund position.
  • orderTransactionCaptureRefund - Detailed JSON object of the order transaction capture refund related to the position.

Dependencies

  • An API key credential for Shopware Admin API authentication

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 if authentication errors occur.
  • If the response is empty or incomplete, verify the _response property setting (basic or detail) to get the desired data format.
  • Timeouts can occur if the server is slow; adjust the timeout setting in Request Options accordingly.

Links

Discussion