SuggestedRefund

Required access

read_orders access scope

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

Show definition
# Represents the suggested refund to be submitted based on the items being returned.
type SuggestedRefund {
  # The total monetary value to be refunded.
  amount: Money!

  # The total monetary value available to refund.
  maximumRefundable: Money!

  # Array of returned line items.
  refundLineItems: [RefundLineItem!]!

  # Refund details for shipping costs paid by customer.
  shipping: ShippingRefund!

  # The sum of all the prices of the line items being refunded.
  subtotal: Money!

  # Array of SuggestedOrderTransaction items.
  suggestedTransactions: [SuggestedOrderTransaction!]!

  # The sum of all the taxes being refunded from the order (must be positive).
  totalTaxes: Money!
}

Fields

amount   (Money!)

The total monetary value to be refunded.

maximumRefundable   (Money!)

The total monetary value available to refund.

refundLineItems   ([RefundLineItem!]!)

Array of returned line items.

shipping   (ShippingRefund!)

Refund details for shipping costs paid by customer.

subtotal   (Money!)

The sum of all the prices of the line items being refunded.

suggestedTransactions   ([SuggestedOrderTransaction!]!)

Array of SuggestedOrderTransaction items.

totalTaxes   (Money!)

The sum of all the taxes being refunded from the order (must be positive).