Suggested
Requires access scope or access scope. Also: The shop must have access to returns processing.
Represents a return financial outcome suggested by Shopify based on the items being reimbursed. You can then use the suggested outcome object to generate an actual refund or invoice for the return.
Anchor to FieldsFields
- Anchor to discountedSubtotaldiscounted•Money
Subtotal Bag! non-null The sum of all the discounted prices of the line items being refunded.
- Anchor to financialTransferfinancial•Return
Transfer Outcome Financial Transfer The financial transfer details for the return outcome.
- Anchor to maximumRefundablemaximum•Money
Refundable Bag! non-null The total monetary value available to refund in shop and presentment currencies.
- Anchor to refundAdditionalFeesrefund•[Refund
Additional Fees Additional Fee!]! non-null A list of additional fees to be refunded from the order.
- Anchor to refundDutiesrefund•[Refund
Duties Duty!]! non-null A list of duties to be refunded from the order.
- Anchor to shippingshipping•Shipping
Refund! non-null The shipping costs to be refunded from the order.
- Anchor to totalAdditionalFeestotal•Money
Additional Fees Bag! non-null The sum of all the additional fees being refunded in shop and presentment currencies. The value must be positive.
- Anchor to totalCartDiscountAmounttotal•Money
Cart Discount Amount Bag! non-null The total cart discount amount that was applied to all line items in this refund.
- Anchor to totalDutiestotal•Money
Duties Bag! 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 totalTaxtotal•Money
Tax Bag! non-null The sum of the taxes being refunded in shop and presentment currencies. The value must be positive.