Skip to main content
object

Requires read_returns access scope.

The Return object represents the intent of a buyer to ship one or more items from an order back to a merchant or a third-party fulfillment location. A return is associated with an order and can include multiple return line items. Each return has a status, which indicates the state of the return.

Use the Return object to capture the financial, logistical, and business intent of a return. For example, you can identify eligible items for a return and issue customers a refund for returned items on behalf of the merchant.

Learn more about providing a return management workflow for merchants. You can also manage exchanges, reverse fulfillment orders, and reverse deliveries on behalf of merchants.

Anchor to Fields and connectionsFields and connections

•ReturnDecline

Additional information about the declined return.

•ExchangeLineItemConnection!
non-null

The exchange line items attached to the return.

•ID!
non-null

A globally-unique ID.

•String!
non-null

The name of the return.

•Order!
non-null

The order that the return belongs to.

•RefundConnection!
non-null

The list of refunds associated with the return.

•ReturnLineItemTypeConnection!
non-null

The return line items attached to the return.

•[ReturnShippingFee!]!
non-null

The return shipping fees for the return.

Anchor to reverseFulfillmentOrdersreverseFulfillmentOrders
•ReverseFulfillmentOrderConnection!
non-null

The list of reverse fulfillment orders for the return.

•ReturnStatus!
non-null

The status of the return.

•SuggestedReturnRefund

A suggested refund for the return.

•Int!
non-null

The sum of all return line item quantities for the return.


Was this section helpful?

•query

Retrieves a return by its ID. A return represents the intent of a buyer to ship one or more items from an order back to a merchant or a third-party fulfillment location.

Use the return query to retrieve information associated with the following workflows:

A return is associated with an order and can include multiple return line items. Each return has a status, which indicates the state of the return.


Was this section helpful?

•mutation

Approves a customer's return request. If this mutation is successful, then the Return.status field of the approved return is set to OPEN.

Arguments

•ReturnApproveRequestInput!
required

The input fields to approve a return.


Fields

•Return

The approved return.

•[ReturnUserError!]!
non-null

The list of errors that occurred from executing the mutation.

•mutation

Cancels a return and restores the items back to being fulfilled. Canceling a return is only available before any work has been done on the return (such as an inspection or refund).

Arguments

•ID!
required

The ID of the return to cancel.

•Boolean
DeprecatedDefault:false

Fields

•Return

The canceled return.

•[ReturnUserError!]!
non-null

The list of errors that occurred from executing the mutation.

•mutation

Indicates a return is complete, either when a refund has been made and items restocked, or simply when it has been marked as returned in the system.

Arguments

•ID!
required

The ID of the return to close.


Fields

•Return

The closed return.

•[ReturnUserError!]!
non-null

The list of errors that occurred from executing the mutation.

•mutation

Creates a return from an existing order that has at least one fulfilled line item that hasn't yet been refunded. If you create a return on an archived order, then the order is automatically unarchived.

Use the returnCreate mutation when your workflow involves approving or declining requested returns outside of the Shopify platform.

The returnCreate mutation performs the following actions:

  • Creates a return in the OPEN state, and assumes that the return request from the customer has already been approved
  • Creates a reverse fulfillment order, and enables you to create a reverse delivery for the reverse fulfillment order
  • Creates a sales agreement with a RETURN reason, which links to all sales created for the return or exchange
  • Generates sales records that reverse the sales records for the items being returned
  • Generates sales records for any exchange line items

After you've created a return, use the return query to retrieve the return by its ID. Learn more about providing a return management workflow for merchants.

Arguments

•ReturnInput!
required

Specifies the input fields for a return.


Fields

•Return

The created return.

•[ReturnUserError!]!
non-null

The list of errors that occurred from executing the mutation.

•mutation

Declines a return on an order. When a return is declined, each ReturnLineItem.fulfillmentLineItem can be associated to a new return. Use the ReturnCreate or ReturnRequest mutation to initiate a new return.

Arguments

•ReturnDeclineRequestInput!
required

The input fields for declining a customer's return request.


Fields

•Return

The declined return.

•[ReturnUserError!]!
non-null

The list of errors that occurred from executing the mutation.

•mutation

Removes return lines from a return.

Arguments

•ID!
required

The ID of the return for line item removal.

•[ReturnLineItemRemoveFromReturnInput!]!
required

The return line items to remove from the return.


Fields

•Return

The modified return.

•[ReturnUserError!]!
non-null

The list of errors that occurred from executing the mutation.

•mutation

Reopens a closed return.

Arguments

•ID!
required

The ID of the return to reopen.


Fields

•Return

The reopened return.

•[ReturnUserError!]!
non-null

The list of errors that occurred from executing the mutation.

•mutation

A customer's return request that hasn't been approved or declined. This mutation sets the value of the Return.status field to REQUESTED. To create a return that has the Return.status field set to OPEN, use the returnCreate mutation.

Arguments

•ReturnRequestInput!
required

The input fields for requesting a return.


Fields

•Return

The requested return.

•[ReturnUserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?

•interface

Was this section helpful?
OSZAR »