Choose a version:

returnProcess

mutation

Requires write_returns access scope or write_marketplace_returns access scope. Also: The shop must have access to returns processing.

Process a return.

Arguments

Anchor to inputinput •ReturnProcessInput! required: Specifies the input fields for processing a return.

Was this section helpful?

Anchor to ReturnProcessPayload returnsReturnProcessPayload returns

Anchor to returnreturn •Return: The processed return.
Anchor to userErrorsuserErrors •[ReturnUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

mutation returnProcess($input: ReturnProcessInput!) {

returnProcess(input: $input) {

return {

# Return fields

}

userErrors {

field

message

}

Input

{

"input": {

"exchangeLineItems": [

{

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

"quantity": 1

}

"financialTransfer": {

"issueRefund": "",

"sendInvoice": ""

"note": "<your-note>",

"notifyCustomer": true,

"refundDuties": [

{

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

"refundType": ""

}

"refundShipping": {

"fullRefund": true,

"shippingRefundAmount": ""

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

"returnLineItems": [

{

"dispositions": [

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

"quantity": 1

}

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

}

{
  "input": {
    "exchangeLineItems": [
      {
        "id": "gid://shopify/<objectName>/10079785100",
        "quantity": 1
      }
    ],
    "financialTransfer": {
      "issueRefund": "",
      "sendInvoice": ""
    },
    "note": "<your-note>",
    "notifyCustomer": true,
    "refundDuties": [
      {
        "dutyId": "gid://shopify/<objectName>/10079785100",
        "refundType": ""
      }
    ],
    "refundShipping": {
      "fullRefund": true,
      "shippingRefundAmount": ""
    },
    "returnId": "gid://shopify/<objectName>/10079785100",
    "returnLineItems": [
      {
        "dispositions": [
          ""
        ],
        "id": "gid://shopify/<objectName>/10079785100",
        "quantity": 1
      }
    ],
    "tipLineId": "gid://shopify/<objectName>/10079785100"
  }
}

input ReturnProcessInput {
  exchangeLineItems: [ReturnProcessExchangeLineItemInput!]
  financialTransfer: ReturnProcessFinancialTransferInput
  note: String
  notifyCustomer: Boolean
  refundDuties: [RefundDutyInput!]
  refundShipping: RefundShippingInput
  returnId: ID!
  returnLineItems: [ReturnProcessReturnLineItemInput!]
  tipLineId: ID
}

input ReturnProcessExchangeLineItemInput {
  id: ID!
  quantity: Int!
}

input ReturnProcessFinancialTransferInput {
  issueRefund: ReturnProcessRefundInput
  sendInvoice: ReturnProcessInvoiceInput
}

input RefundDutyInput {
  dutyId: ID!
  refundType: RefundDutyRefundType
}

input RefundShippingInput {
  fullRefund: Boolean
  shippingRefundAmount: MoneyInput
}

input ReturnProcessReturnLineItemInput {
  dispositions: [ReverseFulfillmentOrderDisposeInput!]
  id: ID!
  quantity: Int!
}