Suggested
Requires access scope or 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
objects to refund with their quantities and restock instructions,
objects for duty reimbursements, and
for shipping cost refunds. Provides
objects and the
interface to process the refund through the appropriate gateways.
Learn more about previewing and refunding duties.
Anchor to FieldsFields
- amountSet (MoneyBag!)
- discountedSubtotalSet (MoneyBag!)
- maximumRefundableSet (MoneyBag!)
- refundAdditionalFees ([RefundAdditionalFee!]!)
- refundDuties ([RefundDuty!]!)
- refundLineItems ([RefundLineItem!]!)
- shipping (ShippingRefund!)
- subtotalSet (MoneyBag!)
- suggestedRefundMethods ([SuggestedRefundMethod!]!)
- suggestedTransactions ([SuggestedOrderTransaction!]!)
- totalAdditionalFeesSet (MoneyBag!)
- totalCartDiscountAmountSet (MoneyBag!)
- totalDutiesSet (MoneyBag!)
- totalTaxSet (MoneyBag!)
- Anchor to amountSetamount•Money
Set Bag! non-null The total monetary value to be refunded in shop and presentment currencies.
Show fields
- Anchor to discountedSubtotalSetdiscounted•Money
Subtotal Set Bag! non-null The sum of all the discounted prices of the line items being refunded.
Show fields
- Anchor to maximumRefundableSetmaximum•Money
Refundable Set Bag! non-null The total monetary value available to refund in shop and presentment currencies.
Show fields
- Anchor to refundAdditionalFeesrefund•[Refund
Additional Fees Additional Fee!]! non-null An array of additional fees that will be refunded to the customer.
Show fields
- Anchor to refundDutiesrefund•[Refund
Duties Duty!]! non-null A list of duties to be refunded from the order.
Show fields
- Anchor to refundLineItemsrefund•[Refund
Line Items Line Item!]! non-null A list of line items to be refunded, along with restock instructions.
Show fields
- Anchor to shippingshipping•Shipping
Refund! non-null The shipping costs to be refunded from the order.
Show fields
- Anchor to subtotalSetsubtotal•Money
Set Bag! non-null The sum of all the prices of the line items being refunded in shop and presentment currencies.
Show fields
- Anchor to suggestedRefundMethodssuggested•[Suggested
Refund Methods Refund Method!]! non-null A list of suggested refund methods.
Show fields
- Anchor to suggestedTransactionssuggested•[Suggested
Transactions Order Transaction!]! non-null A list of suggested order transactions.
Show fields
- Anchor to totalAdditionalFeesSettotal•Money
Additional Fees Set Bag! non-null The sum of all the additional fees being refunded from the order in shop and presentment currencies. The value must be positive.
Show fields
- Anchor to totalCartDiscountAmountSettotal•Money
Cart Discount Amount Set Bag! non-null The total cart discount amount that was applied to all line items in this refund.
Show fields
- Anchor to totalDutiesSettotal•Money
Duties Set Bag! non-null The sum of all the duties being refunded from the order in shop and presentment currencies. The value must be positive.
Show fields
- Anchor to totalTaxSettotal•Money
Tax Set Bag! non-null The sum of the taxes being refunded from the order in shop and presentment currencies. The value must be positive.
Show fields
Deprecated fields
- amount (Money!): deprecated
- maximumRefundable (Money!): deprecated
- subtotal (Money!): deprecated
- totalTaxes (Money!): deprecated
- Anchor to amountamount•Money!non-nullDeprecated
- Anchor to maximumRefundablemaximum•Money!
Refundable non-nullDeprecated - Anchor to subtotalsubtotal•Money!non-nullDeprecated
- Anchor to totalTaxestotal•Money!
Taxes non-nullDeprecated