API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

SuggestedRefund object

Version unstable

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

Required access

read_orders access scope.

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.

refundDuties ([RefundDuty!]!)

An array of duties that will be refunded to the customer.

refundLineItems ([RefundLineItem!]!)

An array of line items that will be returned to the customer.

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.

supportedRefundTypes ( [TransactionSupportedRefundType!] )

The types of refund that the app supports. This argument is deprecated: This field is deprecated, please pass the arguments through the suggestedRefund field.Default value: [CARD_NOT_PRESENT_REFUND]

totalCartDiscountAmountSet (MoneyBag!)

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

totalDutiesSet (MoneyBag!)

The sum of all the duties 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) in shop and presentment currencies.

Types that return SuggestedRefund

Deprecated fields

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

Version 2021-01 (Release candidate)

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

Required access

read_orders access scope.

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.

refundDuties ([RefundDuty!]!)

An array of duties that will be refunded to the customer.

refundLineItems ([RefundLineItem!]!)

An array of line items that will be returned to the customer.

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.

totalDutiesSet (MoneyBag!)

The sum of all the duties 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) in shop and presentment currencies.

Types that return SuggestedRefund

Deprecated fields

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

Version 2020-10 (Latest)

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

Required access

read_orders access scope.

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.

refundDuties ([RefundDuty!]!)

An array of duties that will be refunded to the customer.

refundLineItems ([RefundLineItem!]!)

An array of line items that will be returned to the customer.

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.

totalDutiesSet (MoneyBag!)

The sum of all the duties 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) in shop and presentment currencies.

Types that return SuggestedRefund

Deprecated fields

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

Version 2020-07

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

Required access

read_orders access scope.

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.

refundDuties ([RefundDuty!]!)

An array of duties that will be refunded to the customer.

refundLineItems ([RefundLineItem!]!)

An array of line items that will be returned to the customer.

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.

totalDutiesSet (MoneyBag!)

The sum of all the duties 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) in shop and presentment currencies.

Types that return SuggestedRefund

Deprecated fields

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

Version 2020-04

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

Required access

read_orders access scope.

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.

refundDuties ([RefundDuty!]!)

An array of duties that will be refunded to the customer.

refundLineItems ([RefundLineItem!]!)

An array of line items that will be returned to the customer.

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.

totalDutiesSet (MoneyBag!)

The sum of all the duties 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) in shop and presentment currencies.

Types that return SuggestedRefund

Deprecated fields

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

Version 2020-01

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

Required access

read_orders access scope.

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!]!)

An array of line items that will be returned to the customer.

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.

Types that return SuggestedRefund

Deprecated fields

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

Version 2019-10 (Unsupported)

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

Required access

read_orders access scope.

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!]!)

An array of line items that will be returned to the customer.

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.

Types that return SuggestedRefund

Deprecated fields

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

Version 2019-07 (Unsupported)

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

Required access

read_orders access scope.

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!]!)

An array of line items that will be returned to the customer.

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.

Types that return SuggestedRefund

Deprecated fields

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

Version 2019-04 (Unsupported)

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

Required access

read_orders access scope.

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!]!)

An array of line items that will be returned to the customer.

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.

Types that return SuggestedRefund

Deprecated fields

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