stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > SuggestedRefund

AdminTypes.SuggestedRefund interface

Represents a refund suggested by Shopify based on the items being reimbursed. You can then use the suggested refund object to generate an actual refund.

Signature:

export interface SuggestedRefund 

Properties

Property	Modifiers	Type	Description
amount		Scalars[‘Money’][‘output’]	The total monetary value to be refunded.
amountSet		MoneyBag	The total monetary value to be refunded in shop and presentment currencies.
discountedSubtotalSet		MoneyBag	The sum of all the discounted prices of the line items being refunded.
maximumRefundable		Scalars[‘Money’][‘output’]	The total monetary value available to refund.
maximumRefundableSet		MoneyBag	The total monetary value available to refund in shop and presentment currencies.
refundDuties		Array<RefundDuty>	A list of duties to be refunded from the order.
refundLineItems		Array<RefundLineItem>	A list of line items to be refunded, along with restock instructions.
shipping		ShippingRefund	The shipping costs to be refunded from the order.
subtotal		Scalars[‘Money’][‘output’]	The sum of all the prices of the line items being refunded.
subtotalSet		MoneyBag	The sum of all the prices of the line items being refunded in shop and presentment currencies.
suggestedTransactions		Array<SuggestedOrderTransaction>	A list of suggested order transactions.
totalCartDiscountAmountSet		MoneyBag	The total cart discount amount that was applied to all line items in this refund.
totalDutiesSet		MoneyBag	The sum of all the duties being refunded from the order in shop and presentment currencies. The value must be positive.
totalTaxes		Scalars[‘Money’][‘output’]	The sum of the taxes being refunded from the order. The value must be positive.
totalTaxSet		MoneyBag	The sum of the taxes being refunded from the order in shop and presentment currencies. The value must be positive.