Choose a version:

SuggestedRefund

object

Requires read_orders access scope or read_marketplace_orders access scope.

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.

Anchor to FieldsFields

Anchor to amountSetamountSet •MoneyBag!non-null: The total monetary value to be refunded in shop and presentment currencies.
Anchor to discountedSubtotalSetdiscountedSubtotalSet •MoneyBag!non-null: The sum of all the discounted prices of the line items being refunded.
Anchor to maximumRefundableSetmaximumRefundableSet •MoneyBag!non-null: The total monetary value available to refund in shop and presentment currencies.
Anchor to refundDutiesrefundDuties •[RefundDuty!]!non-null: A list of duties to be refunded from the order.
Anchor to refundLineItemsrefundLineItems •[RefundLineItem!]!non-null: A list of line items to be refunded, along with restock instructions.
Anchor to shippingshipping •ShippingRefund!non-null: The shipping costs to be refunded from the order.
Anchor to subtotalSetsubtotalSet •MoneyBag!non-null: The sum of all the prices of the line items being refunded in shop and presentment currencies.
Anchor to suggestedTransactionssuggestedTransactions •[SuggestedOrderTransaction!]!non-null: A list of suggested order transactions.
Anchor to totalCartDiscountAmountSettotalCartDiscountAmountSet •MoneyBag!non-null: The total cart discount amount that was applied to all line items in this refund.
Anchor to totalDutiesSettotalDutiesSet •MoneyBag!non-null: The sum of all the duties being refunded from the order in shop and presentment currencies. The value must be positive.
Anchor to totalTaxSettotalTaxSet •MoneyBag!non-null: The sum of the taxes being refunded from the order in shop and presentment currencies. The value must be positive.

Deprecated fields

Anchor to amountamount •Money!non-nullDeprecated
Anchor to maximumRefundablemaximumRefundable •Money!non-nullDeprecated
Anchor to subtotalsubtotal •Money!non-nullDeprecated
Anchor to totalTaxestotalTaxes •Money!non-nullDeprecated

Was this section helpful?