Choose a version:

removeFromReturn

mutation

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

Removes return and/or exchange lines from a return.

Arguments

Anchor to exchangeLineItemsexchangeLineItems •[ExchangeLineItemRemoveFromReturnInput!]: The exchange line items to remove from the return.
Anchor to returnIdreturnId •ID! required: The ID of the return for line item removal.
Anchor to returnLineItemsreturnLineItems •[ReturnLineItemRemoveFromReturnInput!]: The return line items to remove from the return.

Was this section helpful?

Anchor to RemoveFromReturnPayload returnsRemoveFromReturnPayload returns

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

Was this section helpful?

Mutation Reference

mutation removeFromReturn($exchangeLineItems: [ExchangeLineItemRemoveFromReturnInput!], $returnId: ID!, $returnLineItems: [ReturnLineItemRemoveFromReturnInput!]) {

removeFromReturn(exchangeLineItems: $exchangeLineItems, returnId: $returnId, returnLineItems: $returnLineItems) {

return {

# Return fields

}

userErrors {

field

message

}

Input

{

"exchangeLineItems": [

{

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

"quantity": 1

}

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

"returnLineItems": [

{

"quantity": 1,

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

}

]

}

{
  "exchangeLineItems": [
    {
      "exchangeLineItemId": "gid://shopify/<objectName>/10079785100",
      "quantity": 1
    }
  ],
  "returnId": "gid://shopify/<objectName>/10079785100",
  "returnLineItems": [
    {
      "quantity": 1,
      "returnLineItemId": "gid://shopify/<objectName>/10079785100"
    }
  ]
}

input ExchangeLineItemRemoveFromReturnInput {
  exchangeLineItemId: ID!
  quantity: Int!
}

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