Skip to main content
Log inSign up
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.

•
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.

•

A list of duties to be refunded from the order.

•

A list of line items to be refunded, along with restock instructions.

•

The shipping costs to be refunded from the order.

•
MoneyBag!non-null

The sum of all the prices of the line items being refunded in shop and presentment currencies.

Anchor to suggestedTransactionssuggestedTransactions
•

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.

•
MoneyBag!non-null

The sum of all the duties being refunded from the order in shop and presentment currencies. The value must be positive.

•
MoneyBag!non-null

The sum of the taxes being refunded from the order in shop and presentment currencies. The value must be positive.

Show
deprecated fields Deprecated
•
Money!non-nullDeprecated

The total monetary value to be refunded. Use amountSet instead.

•
Money!non-nullDeprecated

The total monetary value available to refund. Use maximumRefundableSet instead.

•
Money!non-nullDeprecated

The sum of all the prices of the line items being refunded. Use subtotalSet instead.

•
Money!non-nullDeprecated

The sum of the taxes being refunded from the order. The value must be positive. Use totalTaxSet instead.


Was this section helpful?