returnRefund
mutation

Choose a version:

Requires write_orders access scope or write_marketplace_orders access scope. Also: Requires the write_returns access scope. The user must have refund_orders permission.

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

Anchor to section titled 'Arguments'

Arguments

Anchor to returnRefundInput returnRefundInput ReturnRefundInput! required: The input fields to refund a return.

Was this section helpful?

Anchor to section titled 'ReturnRefundPayload returns'

ReturnRefundPayload returns

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

Was this section helpful?

Code examples for MUTATION: returnRefund

Query Reference for MUTATION: returnRefund

"mutation returnRefund($returnRefundInput: ReturnRefundInput!) {\n  returnRefund(returnRefundInput: $returnRefundInput) {\n    refund {\n      # Refund fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: returnRefund

"{\n  \"returnRefundInput\": {\n    \"note\": \"<your-note>\",\n    \"notifyCustomer\": true,\n    \"orderTransactions\": [\n      {\n        \"parentId\": \"gid://shopify/<objectName>/10079785100\",\n        \"transactionAmount\": {\n          \"amount\": \"29.99\",\n          \"currencyCode\": \"AED\"\n        }\n      }\n    ],\n    \"refundDuties\": [\n      {\n        \"dutyId\": \"gid://shopify/<objectName>/10079785100\",\n        \"refundType\": \"FULL\"\n      }\n    ],\n    \"refundShipping\": {\n      \"fullRefund\": true,\n      \"shippingRefundAmount\": {\n        \"amount\": \"29.99\",\n        \"currencyCode\": \"AED\"\n      }\n    },\n    \"returnId\": \"gid://shopify/<objectName>/10079785100\",\n    \"returnRefundLineItems\": [\n      {\n        \"quantity\": 1,\n        \"returnLineItemId\": \"gid://shopify/<objectName>/10079785100\"\n      }\n    ]\n  }\n}"

Schema Reference for MUTATION: returnRefund

"input ReturnRefundInput {\n  note: String\n  notifyCustomer: Boolean\n  orderTransactions: [ReturnRefundOrderTransactionInput!]\n  refundDuties: [RefundDutyInput!]\n  refundShipping: RefundShippingInput\n  returnId: ID!\n  returnRefundLineItems: [ReturnRefundLineItemInput!]!\n}\n\ninput ReturnRefundOrderTransactionInput {\n  parentId: ID!\n  transactionAmount: MoneyInput!\n}\n\ninput RefundDutyInput {\n  dutyId: ID!\n  refundType: RefundDutyRefundType\n}\n\ninput RefundShippingInput {\n  fullRefund: Boolean\n  shippingRefundAmount: MoneyInput\n}\n\ninput ReturnRefundLineItemInput {\n  quantity: Int!\n  returnLineItemId: ID!\n}\n"

Display Examples for MUTATION: returnRefund

[]

returnRefundmutation

Arguments

ReturnRefundPayload returns

returnRefund
mutation