returnClose

mutation

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

Indicates a return is complete, either when a refund has been made and items restocked, or simply when it has been marked as returned in the system.

Arguments

Anchor to idid • ID!required: The ID of the return to close.

Was this section helpful?

Anchor to ReturnClosePayload returnsReturnClosePayload returns

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

Was this section helpful?

Mutation Reference

1mutation returnClose($id: ID!) {
2  returnClose(id: $id) {
3    return {
4      # Return fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "id": "gid://shopify/<objectName>/10079785100"
3}

{
  "id": "gid://shopify/<objectName>/10079785100"
}