Skip to main content
Anchor to returnRefund

returnRefund

mutation

Requires write_returns access scope or write_marketplace_returns access scope. Also: The user must have refund_orders permission.

Deprecated. Use returnProcess instead.

Creates a refund for items being returned when the return status is OPEN or CLOSED. This mutation processes the financial aspects of a return by refunding line items, shipping costs, and duties back to the customer.

If the order has an existing write-off, calling this mutation can reduce the written-off amount automatically when it reduces the order total before write-offs below the remaining written-off amount.

Anchor to Arguments

Arguments

Anchor to returnRefundInputreturnRefundInput
•ReturnRefundInput!
required

The input fields to refund a return.

Show input fields
Was this section helpful?

Anchor to ReturnRefundPayload returnsReturnRefundPayload returns

Anchor to refundrefund
•Refund

The created refund.

Show fields
Anchor to userErrorsuserErrors
•[ReturnUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Show fields
Was this section helpful?