# returnLineItemRemoveFromReturn - admin-graphql - MUTATION Version: 2024-10 ## Description Removes return lines from a return. ### Access Scopes `write_returns` access scope. Also: The user must have `return_orders` permission. ## Arguments * [returnId](/docs/api/admin-graphql/2024-10/scalars/ID): ID! - The ID of the return for line item removal. * [returnLineItems](/docs/api/admin-graphql/2024-10/input-objects/ReturnLineItemRemoveFromReturnInput): ReturnLineItemRemoveFromReturnInput! - The return line items to remove from the return. ## Returns * [return](/docs/api/admin-graphql/2024-10/objects/Return): Return The modified return. * [userErrors](/docs/api/admin-graphql/2024-10/objects/ReturnUserError): ReturnUserError! The list of errors that occurred from executing the mutation. ## Examples ### Remove a return line item from a return Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation ReturnLineItemRemoveFromReturn($returnId: ID!, $returnLineItems: [ReturnLineItemRemoveFromReturnInput!]!) { returnLineItemRemoveFromReturn(returnId: $returnId, returnLineItems: $returnLineItems) { userErrors { field message } return { id status returnLineItems(first: 10) { edges { node { id quantity } } } } } }\",\n \"variables\": {\n \"returnId\": \"gid://shopify/Return/945000969\",\n \"returnLineItems\": [\n {\n \"returnLineItemId\": \"gid://shopify/ReturnLineItem/791246324\",\n \"quantity\": 1\n }\n ]\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation ReturnLineItemRemoveFromReturn($returnId: ID!, $returnLineItems: [ReturnLineItemRemoveFromReturnInput!]!) {\n returnLineItemRemoveFromReturn(returnId: $returnId, returnLineItems: $returnLineItems) {\n userErrors {\n field\n message\n }\n return {\n id\n status\n returnLineItems(first: 10) {\n edges {\n node {\n id\n quantity\n }\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"returnId\": \"gid://shopify/Return/945000969\",\n \"returnLineItems\": [\n {\n \"returnLineItemId\": \"gid://shopify/ReturnLineItem/791246324\",\n \"quantity\": 1\n }\n ]\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation ReturnLineItemRemoveFromReturn($returnId: ID!, $returnLineItems: [ReturnLineItemRemoveFromReturnInput!]!) {\n returnLineItemRemoveFromReturn(returnId: $returnId, returnLineItems: $returnLineItems) {\n userErrors {\n field\n message\n }\n return {\n id\n status\n returnLineItems(first: 10) {\n edges {\n node {\n id\n quantity\n }\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"returnId\": \"gid://shopify/Return/945000969\",\n \"returnLineItems\": [{\"returnLineItemId\"=>\"gid://shopify/ReturnLineItem/791246324\", \"quantity\"=>1}]\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation ReturnLineItemRemoveFromReturn($returnId: ID!, $returnLineItems: [ReturnLineItemRemoveFromReturnInput!]!) {\n returnLineItemRemoveFromReturn(returnId: $returnId, returnLineItems: $returnLineItems) {\n userErrors {\n field\n message\n }\n return {\n id\n status\n returnLineItems(first: 10) {\n edges {\n node {\n id\n quantity\n }\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"returnId\": \"gid://shopify/Return/945000969\",\n \"returnLineItems\": [\n {\n \"returnLineItemId\": \"gid://shopify/ReturnLineItem/791246324\",\n \"quantity\": 1\n }\n ]\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation ReturnLineItemRemoveFromReturn($returnId: ID!, $returnLineItems: [ReturnLineItemRemoveFromReturnInput!]!) {\n returnLineItemRemoveFromReturn(returnId: $returnId, returnLineItems: $returnLineItems) {\n userErrors {\n field\n message\n }\n return {\n id\n status\n returnLineItems(first: 10) {\n edges {\n node {\n id\n quantity\n }\n }\n }\n }\n }\n}" #### Graphql Input { "returnId": "gid://shopify/Return/945000969", "returnLineItems": [ { "returnLineItemId": "gid://shopify/ReturnLineItem/791246324", "quantity": 1 } ] } #### Graphql Response { "data": { "returnLineItemRemoveFromReturn": { "userErrors": [], "return": { "id": "gid://shopify/Return/945000969", "status": "CLOSED", "returnLineItems": { "edges": [] } } } } }