SuggestedRefund object

Represents the suggested refund to be submitted based on the items being returned.

Required access

read_orders access scope.

On this page

Fields

  • amountSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
    The total monetary value to be refunded in shop and presentment currencies.
  • discountedSubtotalSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
    The sum of all the discounted prices of the line items being refunded.
  • maximumRefundableSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
    The total monetary value available to refund in shop and presentment currencies.
  • refundDuties ([[RefundDuty!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/refundduty))
    An array of duties that will be refunded to the customer.
  • refundLineItems ([[RefundLineItem!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/refundlineitem))
    An array of line items that will be returned to the customer.
  • shipping ([ShippingRefund!](https://shopify.dev/docs/admin-api/graphql/reference/orders/shippingrefund))
    Refund details for shipping costs paid by customer.
  • subtotalSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
    The sum of all the prices of the line items being refunded in shop and presentment currencies.
  • suggestedTransactions ([[SuggestedOrderTransaction!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/suggestedordertransaction))
    Array of SuggestedOrderTransaction items.
  • totalCartDiscountAmountSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
    The total cart discount amount that was applied to all line items in this refund.
  • totalDutiesSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
    The sum of all the duties being refunded from the order in shop and presentment currencies. Must be positive.
  • totalTaxSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
    The sum of all the taxes being refunded from the order (must be positive) in shop and presentment currencies.

Types that return SuggestedRefund

  • [Order.suggestedRefund](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#suggestedrefund-2021-01)

Deprecated fields

  • amount ([Money!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#money-2021-01)) DEPRECATED
    The total monetary value to be refunded.
    Deprecation warning
    Use amountSet instead
  • maximumRefundable ([Money!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#money-2021-01)) DEPRECATED
    The total monetary value available to refund.
    Deprecation warning
    Use maximumRefundableSet instead
  • subtotal ([Money!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#money-2021-01)) DEPRECATED
    The sum of all the prices of the line items being refunded.
    Deprecation warning
    Use subtotalSet instead
  • totalTaxes ([Money!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#money-2021-01)) DEPRECATED
    The sum of all the taxes being refunded from the order (must be positive).
    Deprecation warning
    Use totalTaxSet instead