CalculateRefund
Calculates refund amounts for order line items and shipping, returning a breakdown of refundable totals.
Input
| Name | Type | Description |
| OrderId | String | The unique identifier of the order being refunded. |
| Currency | String | The ISO 4217 currency code used for the refund. Required if a ShippingAmount is provided. |
| RefundLineItems | String | A JSON array specifying the line item IDs, quantities to refund, and restock instructions. |
| ShippingFullRefund | String | Indicates whether the full remaining shipping amount should be refunded. |
| ShippingAmount | Double | A specific shipping amount to refund. This value takes precedence over ShippingFullRefund if both are provided. |
Result Set Columns
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation completed successfully. |
| Details | String | Additional information or context about the execution of the operation. |
| AdditionalFees | String | A JSON aggregate detailing any additional fees included in the refund. |
| Currency | String | The ISO 4217 currency code used for the refund. |
| Duties | String | A JSON aggregate of refunded duties included as part of this refund. |
| RefundLineItems | String | A JSON array containing line item IDs, quantities refunded, and restock details. |
| Return | String | A JSON array describing the items being returned to the merchant. |
| ShippingAmount | Decimal | The refunded shipping amount, expressed as a decimal. |
| ShippingMaximumRefundable | Decimal | The maximum refundable shipping amount available for this order. |
| ShippingTax | Decimal | The tax amount associated with the refunded shipping. |
| TotalAdditionalFeesSetPresentmentMoneyAmount | Decimal | The total amount of additional fees refunded, expressed in presentment currency. |
| TotalAdditionalFeesSetPresentmentMoneyCurrencyCode | String | The ISO 4217 currency code for the refunded additional fees in presentment currency. |
| TotalAdditionalFeesSetShopMoneyAmount | Decimal | The total amount of additional fees refunded, expressed in shop currency. |
| TotalAdditionalFeesSetShopMoneyCurrencyCode | String | The ISO 4217 currency code for the refunded additional fees in shop currency. |
| TotalDutiesSetPresentmentMoneyAmount | Decimal | The total refunded duties amount, expressed in presentment currency. |
| TotalDutiesSetPresentmentMoneyCurrencyCode | String | The ISO 4217 currency code for the refunded duties in presentment currency. |
| TotalDutiesSetShopMoneyAmount | Decimal | The total refunded duties amount, expressed in shop currency. |
| TotalDutiesSetShopMoneyCurrencyCode | String | The ISO 4217 currency code for the refunded duties in shop currency. |
| TransactionsOrderId | Long | The unique identifier of the transaction order associated with the refund. |
| TransactionsKind | String | The type of transaction, indicating whether the refund will be accepted or pending. |
| TransactionsGateway | String | The payment gateway used to process the refund transaction. |
| TransactionsParentId | Long | The unique identifier of the parent transaction, if applicable. |
| TransactionsAmount | Decimal | The refunded transaction amount, expressed as a decimal. |
| TransactionsCurrencyCode | String | The ISO 4217 currency code used for the transaction refund. |
| TransactionsMaximumRefundable | Decimal | The maximum refundable transaction amount available for this payment. |