Anchor to section titled 'undefined'

returnLineItemRemoveFromReturn
mutation

Requires write_returns access scope. Also: The user must have return_orders permission.

Removes return lines from a return.

Anchor to section titled 'Arguments'

Arguments

Anchor to returnId
returnId
ID!
required

The ID of the return for line item removal.

Anchor to returnLineItems
returnLineItems
[ReturnLineItemRemoveFromReturnInput!]!
required

The return line items to remove from the return.

Was this section helpful?
Anchor to section titled 'ReturnLineItemRemoveFromReturnPayload returns'

ReturnLineItemRemoveFromReturnPayload returns

Anchor to ReturnLineItemRemoveFromReturnPayload.return
return
Return

The modified return.

Anchor to ReturnLineItemRemoveFromReturnPayload.userErrors
userErrors
[ReturnUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation returnLineItemRemoveFromReturn($returnId: ID!, $returnLineItems: [ReturnLineItemRemoveFromReturnInput!]!) {
  returnLineItemRemoveFromReturn(returnId: $returnId, returnLineItems: $returnLineItems) {
    return {
      # Return fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "returnId": "gid://shopify/<objectName>/10079785100",
  "returnLineItems": [
    {
      "quantity": 1,
      "returnLineItemId": "gid://shopify/<objectName>/10079785100"
    }
  ]
}
input ReturnLineItemRemoveFromReturnInput {
  quantity: Int!
  returnLineItemId: ID!
}