Choose a version:

orderRequestReturn

mutation

Request a new return on behalf of a customer.

Arguments

Anchor to orderIdorderId •ID! required: The ID of the order for which this return is being requested.
Anchor to requestedLineItemsrequestedLineItems •[RequestedLineItemInput!]! required: The line items that are requested to be returned.

Was this section helpful?

Anchor to OrderRequestReturnPayload returnsOrderRequestReturnPayload returns

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

Was this section helpful?

Mutation Reference

mutation orderRequestReturn($orderId: ID!, $requestedLineItems: [RequestedLineItemInput!]!) {

orderRequestReturn(orderId: $orderId, requestedLineItems: $requestedLineItems) {

return {

# Return fields

}

userErrors {

field

message

}

Input

{

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

"requestedLineItems": [

{

"customerNote": "<your-customerNote>",

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

"quantity": 1,

"returnReason": ""

}

]

}

{
  "orderId": "gid://shopify/<objectName>/10079785100",
  "requestedLineItems": [
    {
      "customerNote": "<your-customerNote>",
      "lineItemId": "gid://shopify/<objectName>/10079785100",
      "quantity": 1,
      "returnReason": ""
    }
  ]
}

input RequestedLineItemInput {
  customerNote: String
  lineItemId: ID!
  quantity: Int!
  returnReason: ReturnReason!
}