Anchor to section titled 'undefined'

ReturnUserError
object

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

Anchor to section titled 'Fields'

Fields

Anchor to ReturnUserError.code
code
ReturnErrorCode

The error code.

Anchor to ReturnUserError.field
field
[String!]

The path to the input field that caused the error.

Anchor to ReturnUserError.message
message
String!
non-null

The error message.

Was this section helpful?
Map
  • No referencing fields
    • ReturnUserError
    Anchor to section titled 'Mutations'

    Mutations

    Anchor to returnApproveRequest
    returnApproveRequest
    mutation
    Access requirements

    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 returnCancel
    returnCancel
    mutation
    Access requirements

    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 returnClose
    returnClose
    mutation
    Access requirements

    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 returnCreate
    returnCreate
    mutation
    Access requirements

    Creates a return.

    Anchor to returnDeclineRequest
    returnDeclineRequest
    mutation
    Access requirements

    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 returnRefund
    returnRefund
    mutation
    Access requirements

    Refunds a return when its status is OPEN or CLOSED and associates it with the related return request.

    Anchor to returnReopen
    returnReopen
    mutation
    Access requirements

    Reopens a closed return.

    Anchor to returnRequest
    returnRequest
    mutation
    Access requirements

    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 reverseDeliveryCreateWithShipping
    reverseDeliveryCreateWithShipping
    mutation
    Access requirements

    Creates a new reverse delivery with associated external shipping information.

    Anchor to reverseDeliveryShippingUpdate
    reverseDeliveryShippingUpdate
    mutation
    Access requirements

    Updates a reverse delivery with associated external shipping information.

    Anchor to reverseFulfillmentOrderDispose
    reverseFulfillmentOrderDispose
    mutation
    Access requirements

    Disposes reverse fulfillment order line items.

    Was this section helpful?
    <~>
    ReturnUserError Mutations
    ReturnUserError

    Mutated by

    Anchor to section titled 'Implements'

    Implements

    Anchor to DisplayableError
    DisplayableError
    interface
    Was this section helpful?
    ||-
    ReturnUserError Implements
    ReturnUserError

    Implements