CalculateRefund
Calculates refund transactions based on line items and shipping.
Input
Name | Type | Description |
OrderId | String | The id of the order. |
Currency | String | The ISO format for the currency used to refund. Required when the ShippingAmount is provided. |
RefundLineItems | String | A list of line item IDs, quantities to refund, and restock instructions. |
ShippingFullRefund | String | Specify whether to refund all remaining shipping. |
ShippingAmount | Double | Specify a specific amount to refund for shipping. Takes precedence over ShippingFullRefund. |
Result Set Columns
Name | Type | Description |
Success | Boolean | Indicates whether or not the operation executed successfully. |
Details | String | Any extra details on the operation's execution. |
AdditionalFees | String | A JSON aggregate for additional fees. |
Currency | String | The ISO format for the currency used to refund. |
Duties | String | A JSON aggregate of the refunded duties as part of this refund. |
RefundLineItems | String | A JSON aggregate of line item IDs, quantities to refund, and restock instructions. |
Return | String | The items that will be returned to the merchant. |
ShippingAmount | Decimal | The decimal amount for shipping. |
ShippingMaximumRefundable | Decimal | The maximum amount that can be refunded for shipping. |
ShippingTax | Decimal | The tax amount for the shipping. |
TotalAdditionalFeesSetPresentmentMoneyAmount | Decimal | The decimal amount for additional fees presentment money. |
TotalAdditionalFeesSetPresentmentMoneyCurrencyCode | String | The currency for additional fees presentment money. |
TotalAdditionalFeesSetShopMoneyAmount | Decimal | The decimal amount for additional fees shop money. |
TotalAdditionalFeesSetShopMoneyCurrencyCode | String | The currency for additional fees shop money. |
TotalDutiesSetPresentmentMoneyAmount | Decimal | The decimal amount for duties presentment money. |
TotalDutiesSetPresentmentMoneyCurrencyCode | String | The currency for for duties presentment money. |
TotalDutiesSetShopMoneyAmount | Decimal | The decimal amount for duties shop money. |
TotalDutiesSetShopMoneyCurrencyCode | String | The currency for duties shop money. |
TransactionsOrderId | Long | The id of the transaction order. |
TransactionsKind | String | The kind of transaction. Indicates whether the refund will be accepted. |
TransactionsGateway | String | The gateway of the transaction. |
TransactionsParentId | Long | The parent ID for the transaction. |
TransactionsAmount | Decimal | The decimal amount for the transaction. |
TransactionsCurrencyCode | String | The currency for the transaction. |
TransactionsMaximumRefundable | Decimal | The maximum amount that can be refunded for transaction. |