ReturnUserError - admin-graphql - OBJECT

Version: 2024-10

Description:

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

Access Scopes

Fields

  • code: ReturnErrorCode - The error code.
  • field: String - The path to the input field that caused the error.
  • message: String! - The error message.

Connections

Related queries

Related mutations

  • returnApproveRequest Approves a customer's return request. If this mutation is successful, then the `Return.status` field of the approved return is set to `OPEN`.
  • returnCancel 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).
  • returnClose 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.
  • returnCreate Creates a return.
  • returnDeclineRequest 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.
  • returnLineItemRemoveFromReturn Removes return lines from a return.
  • returnRefund Refunds a return when its status is `OPEN` or `CLOSED` and associates it with the related return request.
  • returnReopen Reopens a closed return.
  • returnRequest 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.
  • reverseDeliveryCreateWithShipping Creates a new reverse delivery with associated external shipping information.
  • reverseDeliveryShippingUpdate Updates a reverse delivery with associated external shipping information.
  • reverseFulfillmentOrderDispose Disposes reverse fulfillment order line items.

Related Unions

Examples