Choose a version:

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.

Anchor to Arguments

Arguments

Anchor to returnRefundInputreturnRefundInput

•ReturnRefundInput!

required

The input fields to refund a return.

Was this section helpful?

Anchor to ReturnRefundPayload returnsReturnRefundPayload returns

Anchor to refundrefund •Refund: The created refund.
Anchor to userErrorsuserErrors •[ReturnUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

returnRefund reference

Mutation Reference

mutation returnRefund($returnRefundInput: ReturnRefundInput!) {

returnRefund(returnRefundInput: $returnRefundInput) {

refund {

# Refund fields

}

userErrors {

field

message

}

Input

{

"returnRefundInput": {

"returnId": "gid://shopify/<objectName>/10079785100",

"returnRefundLineItems": [

{

"returnLineItemId": "gid://shopify/<objectName>/10079785100",

"quantity": 1

}

"refundShipping": {

"shippingRefundAmount": {},

"fullRefund": true

"refundDuties": [

{

"dutyId": "gid://shopify/<objectName>/10079785100",

"refundType": "PROPORTIONAL"

}

"orderTransactions": [

{

"transactionAmount": {},

"parentId": "gid://shopify/<objectName>/10079785100"

}

"notifyCustomer": true

}

Variables

{
  "returnRefundInput": {
    "returnId": "gid://shopify/<objectName>/10079785100",
    "returnRefundLineItems": [
      {
        "returnLineItemId": "gid://shopify/<objectName>/10079785100",
        "quantity": 1
      }
    ],
    "refundShipping": {
      "shippingRefundAmount": {},
      "fullRefund": true
    },
    "refundDuties": [
      {
        "dutyId": "gid://shopify/<objectName>/10079785100",
        "refundType": "PROPORTIONAL"
      }
    ],
    "orderTransactions": [
      {
        "transactionAmount": {},
        "parentId": "gid://shopify/<objectName>/10079785100"
      }
    ],
    "notifyCustomer": true
  }
}

Schema

input ReturnRefundInput {
  returnId: ID!
  returnRefundLineItems: [ReturnRefundLineItemInput!]!
  refundShipping: RefundShippingInput
  refundDuties: [RefundDutyInput!]
  orderTransactions: [ReturnRefundOrderTransactionInput!]
  notifyCustomer: Boolean
}

input ReturnRefundLineItemInput {
  returnLineItemId: ID!
  quantity: Int!
}

input RefundShippingInput {
  shippingRefundAmount: MoneyInput
  fullRefund: Boolean
}

input RefundDutyInput {
  dutyId: ID!
  refundType: RefundDutyRefundType
}

input ReturnRefundOrderTransactionInput {
  transactionAmount: MoneyInput!
  parentId: ID!
}