Anchor to removeFromReturnremove
mutationremove
Requires access scope. Also: The user must have permission.
Removes return and/or exchange lines from a return.
If the order has an existing write-off, calling this mutation can reduce the written-off amount automatically when it reduces the order total before write-offs below the remaining written-off amount.
Anchor to Arguments
Arguments
- exchangeLineItems ([ExchangeLineItemRemoveFromReturnInput!])
- returnId (ID!)
- returnLineItems ([ReturnLineItemRemoveFromReturnInput!])
- Anchor to exchangeLineItemsexchange•[Exchange
Line Items Line Item Remove From Return Input!] The exchange line items to remove from the return.
Show input fields
- Anchor to returnIdreturn•ID!
Id required The ID of the return for line item removal.
- Anchor to returnLineItemsreturn•[Return
Line Items Line Item Remove From Return Input!] The return line items to remove from the return.
Show input fields
Was this section helpful?
- return (Return)
- userErrors ([ReturnUserError!]!)
- Anchor to returnreturn•Return
The modified return.
Show fields
- Anchor to userErrorsuser•[Return
Errors User Error!]! non-null The list of errors that occurred from executing the mutation.
Show fields
Was this section helpful?