OrderSuggestRefund
Retrieves a suggested refund for an order based on line items, duties, shipping, and the refund method allocation.
Procedure-Specific Information
The following inputs can accept either temporary table names or JSON aggregates that match the structure of the referenced table as values.
- RefundLineItems references the RefundLineItemInputs temporary table.
- RefundDuties references the RefundDutyInputs temporary table.
RefundLineItemInputs Temporary Table Columns
| Column Name | Type | Description |
| LineItemId | String | The ID of the line item to refund. |
| Quantity | Int | The quantity of the line item to refund. |
| LocationId | String | The ID of the location where the items will be restocked. |
| RestockType | String | The type of restock for the refunded line item. |
RefundDutyInputs Temporary Table Columns
| Column Name | Type | Description |
| DutyId | String | The ID of the duty to refund. |
| RefundType | String | The type of refund for the duty. |
Input
| Name | Type | Required | Description |
| Id | String | True | The ID of the order to suggest a refund for. |
| ShippingAmount | Decimal | False | The amount of shipping to refund. Ignored when RefundShipping is set. |
| RefundShipping | Boolean | False | Whether to refund the full shipping amount. Takes precedence over ShippingAmount. |
| RefundLineItems | String | False | Line items to refund. |
| RefundDuties | String | False | Duties to refund. |
| SuggestFullRefund | Boolean | False | Whether to suggest a full refund regardless of the other inputs. Defaults to false. |
| RefundMethodAllocation | String | False | How the refund amount should be allocated across refund methods. Defaults to ORIGINAL_PAYMENT_METHODS.
The allowed values are ORIGINAL_PAYMENT_METHODS, STORE_CREDIT. |
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. |
| AmountSetShopMoneyAmount | Decimal | Amount of the suggested refund in shop currency. |
| AmountSetShopMoneyCurrencyCode | String | Currency code of the suggested refund in shop currency. |
| AmountSetPresentmentMoneyAmount | Decimal | Amount of the suggested refund in presentment currency. |
| AmountSetPresentmentMoneyCurrencyCode | String | Currency code of the suggested refund in presentment currency. |
| DiscountedSubtotalSetShopMoneyAmount | Decimal | Discounted subtotal amount in shop currency. |
| DiscountedSubtotalSetShopMoneyCurrencyCode | String | Discounted subtotal currency code in shop currency. |
| DiscountedSubtotalSetPresentmentMoneyAmount | Decimal | Discounted subtotal amount in presentment currency. |
| DiscountedSubtotalSetPresentmentMoneyCurrencyCode | String | Discounted subtotal currency code in presentment currency. |
| MaximumRefundableSetShopMoneyAmount | Decimal | Maximum refundable amount in shop currency. |
| MaximumRefundableSetShopMoneyCurrencyCode | String | Maximum refundable currency code in shop currency. |
| MaximumRefundableSetPresentmentMoneyAmount | Decimal | Maximum refundable amount in presentment currency. |
| MaximumRefundableSetPresentmentMoneyCurrencyCode | String | Maximum refundable currency code in presentment currency. |
| SubtotalSetShopMoneyAmount | Decimal | Subtotal amount in shop currency. |
| SubtotalSetShopMoneyCurrencyCode | String | Subtotal currency code in shop currency. |
| SubtotalSetPresentmentMoneyAmount | Decimal | Subtotal amount in presentment currency. |
| SubtotalSetPresentmentMoneyCurrencyCode | String | Subtotal currency code in presentment currency. |
| TotalCartDiscountAmountSetShopMoneyAmount | Decimal | Total cart discount amount in shop currency. |
| TotalCartDiscountAmountSetShopMoneyCurrencyCode | String | Total cart discount currency code in shop currency. |
| TotalCartDiscountAmountSetPresentmentMoneyAmount | Decimal | Total cart discount amount in presentment currency. |
| TotalCartDiscountAmountSetPresentmentMoneyCurrencyCode | String | Total cart discount currency code in presentment currency. |
| TotalDutiesSetShopMoneyAmount | Decimal | Total duties amount in shop currency. |
| TotalDutiesSetShopMoneyCurrencyCode | String | Total duties currency code in shop currency. |
| TotalDutiesSetPresentmentMoneyAmount | Decimal | Total duties amount in presentment currency. |
| TotalDutiesSetPresentmentMoneyCurrencyCode | String | Total duties currency code in presentment currency. |
| TotalTaxSetShopMoneyAmount | Decimal | Total tax amount in shop currency. |
| TotalTaxSetShopMoneyCurrencyCode | String | Total tax currency code in shop currency. |
| TotalTaxSetPresentmentMoneyAmount | Decimal | Total tax amount in presentment currency. |
| TotalTaxSetPresentmentMoneyCurrencyCode | String | Total tax currency code in presentment currency. |
| ShippingAmountSetShopMoneyAmount | Decimal | Shipping refund amount in shop currency. |
| ShippingAmountSetShopMoneyCurrencyCode | String | Shipping refund currency code in shop currency. |
| ShippingAmountSetPresentmentMoneyAmount | Decimal | Shipping refund amount in presentment currency. |
| ShippingAmountSetPresentmentMoneyCurrencyCode | String | Shipping refund currency code in presentment currency. |
| ShippingMaximumRefundableSetShopMoneyAmount | Decimal | Maximum refundable shipping amount in shop currency. |
| ShippingMaximumRefundableSetShopMoneyCurrencyCode | String | Maximum refundable shipping currency code in shop currency. |
| ShippingMaximumRefundableSetPresentmentMoneyAmount | Decimal | Maximum refundable shipping amount in presentment currency. |
| ShippingMaximumRefundableSetPresentmentMoneyCurrencyCode | String | Maximum refundable shipping currency code in presentment currency. |
| ShippingTaxSetShopMoneyAmount | Decimal | Shipping tax amount in shop currency. |
| ShippingTaxSetShopMoneyCurrencyCode | String | Shipping tax currency code in shop currency. |
| ShippingTaxSetPresentmentMoneyAmount | Decimal | Shipping tax amount in presentment currency. |
| ShippingTaxSetPresentmentMoneyCurrencyCode | String | Shipping tax currency code in presentment currency. |
| SuggestedRefundMethods | String | JSON aggregate of the suggested refund method allocations. |
| RefundLineItems | String | JSON aggregate of the refund line items suggested for this refund. |
| RefundDuties | String | JSON aggregate of the duties suggested for refund. |
| SuggestedTransactions | String | JSON aggregate of the suggested order transactions for this refund. |