Skip to main content
Anchor to OrderReturnInformation

OrderReturnInformation

object

Requires customer_read_orders access scope.

The return information for a specific order.

•Boolean!
non-null

Whether the order has one or more restocking fees associated with its returnable line items.

Anchor to hasReturnShippingFeehasReturnShippingFee
•Boolean!
non-null

Whether the order has one or more return shipping fees associated with its returnable line items.

Anchor to nonReturnableLineItemsnonReturnableLineItems
•NonReturnableLineItemConnection!
non-null

The line items that are not eligible for return.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•Boolean
Default:false

Reverse the order of the underlying list.


Anchor to nonReturnableSummarynonReturnableSummary
•OrderNonReturnableSummary

The summary of reasons why the order is ineligible for return.

•ReturnableLineItemConnection!
non-null

The line items that are eligible for return.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•Boolean
Default:false

Reverse the order of the underlying list.


•[ReturnFee!]!
non-null

The subtotal of all fees associated with return processing that have been applied to the order (e.g. return shipping fees or restocking fees), aggregated by fee type.

Anchor to returnShippingMethodNotereturnShippingMethodNote
•String

Note for the buyer about the return shipping method. Possible values are: "merchant_provided_label", "no_shipping_required", or a localized message that the buyer is responsible for return shipping.

Anchor to returnShippingMethodsreturnShippingMethods
•[ReturnShippingMethod!]!
non-null

A set of return shipping methods associated with the order's returnable line items. Return shipping methods are defined by the return rules at the time the order is placed.


Was this section helpful?