Choose a version:

SuggestedRefund

object

Requires read_orders access scope or read_marketplace_orders access scope.

A refund amount that Shopify suggests based on the items, duties, and shipping costs that customers return. Provides a breakdown of all monetary values including subtotals, taxes, discounts, and the maximum refundable amount.

The suggested refund includes RefundLineItem objects to refund with their quantities and restock instructions, RefundDuty objects for duty reimbursements, and ShippingRefund for shipping cost refunds. Provides SuggestedOrderTransaction objects and the SuggestedRefundMethod interface to process the refund through the appropriate gateways.

Learn more about previewing and refunding duties.

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 suggestedRefundMethodssuggestedRefundMethods •[SuggestedRefundMethod!]! non-null: A list of suggested refund methods.
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?