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 to be refunded in shop and presentment currencies.
  amountSet: MoneyBag!

  # The sum of all the discounted prices of the line items being refunded.
  discountedSubtotalSet: MoneyBag!

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

  # The total monetary value available to refund in shop and presentment currencies.
  maximumRefundableSet: MoneyBag!

  # 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!

  # The sum of all the prices of the line items being refunded in shop and presentment currencies.
  subtotalSet: MoneyBag!

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

  # The total cart discount amount that was applied to all line items in this refund.
  totalCartDiscountAmountSet: MoneyBag!

  # The sum of all the taxes being refunded from the order (must be positive) in shop and presentment currencies.
  totalTaxSet: MoneyBag!

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

Fields

amountSet   (MoneyBag!)

The total monetary value to be refunded in shop and presentment currencies.

discountedSubtotalSet   (MoneyBag!)

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

maximumRefundableSet   (MoneyBag!)

The total monetary value available to refund in shop and presentment currencies.

refundLineItems   ([RefundLineItem!]!)

Array of returned line items.

shipping   (ShippingRefund!)

Refund details for shipping costs paid by customer.

subtotalSet   (MoneyBag!)

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

suggestedTransactions   ([SuggestedOrderTransaction!]!)

Array of SuggestedOrderTransaction items.

totalCartDiscountAmountSet   (MoneyBag!)

The total cart discount amount that was applied to all line items in this refund.

totalTaxSet   (MoneyBag!)

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

Deprecated fields

Show/Hide

amount   (Money!)

deprecated

The total monetary value to be refunded.

Deprecation warning

Use amountSet instead

maximumRefundable   (Money!)

deprecated

The total monetary value available to refund.

Deprecation warning

Use maximumRefundableSet instead

subtotal   (Money!)

deprecated

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

Deprecation warning

Use subtotalSet instead

totalTaxes   (Money!)

deprecated

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

Deprecation warning

Use totalTaxSet instead

Sign up for a Partner account to get started.

Sign up