SuggestedReturnRefund

object

Requires read_orders access scope or read_marketplace_orders access scope. Also: Requires the read_returns access scope.

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

Anchor to FieldsFields

Anchor to amountamount • MoneyBag!non-null: The total monetary value to be refunded in shop and presentment currencies.
Anchor to discountedSubtotaldiscountedSubtotal • MoneyBag!non-null: The sum of all the discounted prices of the line items being refunded.
Anchor to maximumRefundablemaximumRefundable • 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 shippingshipping • ShippingRefund!non-null: The shipping costs to be refunded from the order.
Anchor to subtotalsubtotal • 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 totalCartDiscountAmounttotalCartDiscountAmount • MoneyBag!non-null: The total cart discount amount that was applied to all line items in this refund.
Anchor to totalDutiestotalDuties • 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 totalTaxtotalTax • MoneyBag!non-null: The sum of the taxes being refunded in shop and presentment currencies. The value must be positive.

Was this section helpful?