returnLineItemRemoveFromReturn
mutation

Choose a version:

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?

Code examples for MUTATION: returnLineItemRemoveFromReturn

Query Reference for MUTATION: returnLineItemRemoveFromReturn

"mutation returnLineItemRemoveFromReturn($returnId: ID!, $returnLineItems: [ReturnLineItemRemoveFromReturnInput!]!) {\n  returnLineItemRemoveFromReturn(returnId: $returnId, returnLineItems: $returnLineItems) {\n    return {\n      # Return fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: returnLineItemRemoveFromReturn

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

Schema Reference for MUTATION: returnLineItemRemoveFromReturn

"input ReturnLineItemRemoveFromReturnInput {\n  quantity: Int!\n  returnLineItemId: ID!\n}\n"

Display Examples for MUTATION: returnLineItemRemoveFromReturn

[]

returnLineItemRemoveFromReturnmutation

Arguments

ReturnLineItemRemoveFromReturnPayload returns

returnLineItemRemoveFromReturn
mutation