Skip to main content
Anchor to ReturnUserError

ReturnUserError

object

An error that occurs during the execution of a return mutation.

Anchor to FieldsFields

Anchor to codecode
•ReturnErrorCode

The error code.

Anchor to fieldfield
•[String!]

The path to the input field that caused the error.

Anchor to messagemessage
•String!
non-null

The error message.

Was this section helpful?

Anchor to MutationsMutations

Anchor to removeFromReturnremoveFromReturn
•mutation

Removes return and/or exchange lines from a return.

Anchor to returnApproveRequestreturnApproveRequest
•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.

Anchor to returnCancelreturnCancel
•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).

Anchor to returnClosereturnClose
•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.

Anchor to returnCreatereturnCreate
•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.

Anchor to returnDeclineRequestreturnDeclineRequest
•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.

Anchor to returnProcessreturnProcess
•mutation

Process a return.

Anchor to returnReopenreturnReopen
•mutation

Reopens a closed return.

Anchor to returnRequestreturnRequest
•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.

Anchor to reverseDeliveryCreateWithShippingreverseDeliveryCreateWithShipping
•mutation

Creates a new reverse delivery with associated external shipping information.

Anchor to reverseDeliveryShippingUpdatereverseDeliveryShippingUpdate
•mutation

Updates a reverse delivery with associated external shipping information.

Anchor to reverseFulfillmentOrderDisposereverseFulfillmentOrderDispose
•mutation

Disposes reverse fulfillment order line items.

Deprecated mutations

Anchor to returnLineItemRemoveFromReturnreturnLineItemRemoveFromReturn
•mutation
Deprecated
Anchor to returnRefundreturnRefund
•mutation
Deprecated
Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?