Anchor to section titled 'undefined'return
return
mutation
2024-10latest
Requires write access scope or write access scope. Also: Requires the write access scope. The user must have return permission.
A customer's return request that hasn't been approved or declined.
This mutation sets the value of the Return.status field to R.
To create a return that has the Return.status field set to O, use the return mutation.
Anchor to section titled 'Arguments'
Arguments
The input fields for requesting a return.
Was this section helpful?
Anchor to section titled 'ReturnRequestPayload returns'
ReturnRequestPayload returns
The requested return.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: returnRequest
Query Reference for MUTATION: returnRequest
"mutation returnRequest($input: ReturnRequestInput!) {\n returnRequest(input: $input) {\n return {\n # Return fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: returnRequest
"{\n \"input\": {\n \"orderId\": \"gid://shopify/<objectName>/10079785100\",\n \"returnLineItems\": [\n {\n \"customerNote\": \"<your-customerNote>\",\n \"fulfillmentLineItemId\": \"gid://shopify/<objectName>/10079785100\",\n \"quantity\": 1,\n \"restockingFee\": {\n \"percentage\": 1.1\n },\n \"returnReason\": \"COLOR\"\n }\n ],\n \"returnShippingFee\": {\n \"amount\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n }\n }\n }\n}"Schema Reference for MUTATION: returnRequest
"input ReturnRequestInput {\n orderId: ID!\n returnLineItems: [ReturnRequestLineItemInput!]!\n returnShippingFee: ReturnShippingFeeInput\n}\n\ninput ReturnRequestLineItemInput {\n customerNote: String\n fulfillmentLineItemId: ID!\n quantity: Int!\n restockingFee: RestockingFeeInput\n returnReason: ReturnReason!\n}\n\ninput ReturnShippingFeeInput {\n amount: MoneyInput!\n}\n"Display Examples for MUTATION: returnRequest
[
{
"example": {
"type_name": "returnrequest",
"title": "Request a return",
"description": "Request a return for the order.\n",
"query_string": "mutation ReturnRequest($input: ReturnRequestInput!) {\n returnRequest(input: $input) {\n userErrors {\n field\n message\n }\n return {\n id\n status\n returnLineItems(first: 1) {\n edges {\n node {\n id\n returnReason\n customerNote\n }\n }\n }\n order {\n id\n }\n }\n }\n}",
"variables": {
"input": {
"orderId": "gid://shopify/Order/625362839",
"returnLineItems": [
{
"fulfillmentLineItemId": "gid://shopify/FulfillmentLineItem/820022594",
"quantity": 1,
"returnReason": "WRONG_ITEM",
"customerNote": "Sorry, I ordered the wrong item. Could I get a refund or store credit?"
}
]
}
},
"response": {
"data": {
"returnRequest": {
"userErrors": [],
"return": {
"id": "gid://shopify/Return/945000961",
"status": "REQUESTED",
"returnLineItems": {
"edges": [
{
"node": {
"id": "gid://shopify/ReturnLineItem/677614678",
"returnReason": "WRONG_ITEM",
"customerNote": "Sorry, I ordered the wrong item. Could I get a refund or store credit?"
}
}
]
},
"order": {
"id": "gid://shopify/Order/625362839"
}
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/returns/test/unit/graph_api/admin/mutations/return_request_test.rb",
"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 ReturnRequest($input: ReturnRequestInput!) { returnRequest(input: $input) { userErrors { field message } return { id status returnLineItems(first: 1) { edges { node { id returnReason customerNote } } } order { id } } } }\",\n \"variables\": {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/625362839\",\n \"returnLineItems\": [\n {\n \"fulfillmentLineItemId\": \"gid://shopify/FulfillmentLineItem/820022594\",\n \"quantity\": 1,\n \"returnReason\": \"WRONG_ITEM\",\n \"customerNote\": \"Sorry, I ordered the wrong item. Could I get a refund or store credit?\"\n }\n ]\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation ReturnRequest($input: ReturnRequestInput!) {\n returnRequest(input: $input) {\n userErrors {\n field\n message\n }\n return {\n id\n status\n returnLineItems(first: 1) {\n edges {\n node {\n id\n returnReason\n customerNote\n }\n }\n }\n order {\n id\n }\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/625362839\",\n \"returnLineItems\": [\n {\n \"fulfillmentLineItemId\": \"gid://shopify/FulfillmentLineItem/820022594\",\n \"quantity\": 1,\n \"returnReason\": \"WRONG_ITEM\",\n \"customerNote\": \"Sorry, I ordered the wrong item. Could I get a refund or store credit?\"\n }\n ]\n }\n },\n },\n);\n\nconst data = await response.json();\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 ReturnRequest($input: ReturnRequestInput!) {\n returnRequest(input: $input) {\n userErrors {\n field\n message\n }\n return {\n id\n status\n returnLineItems(first: 1) {\n edges {\n node {\n id\n returnReason\n customerNote\n }\n }\n }\n order {\n id\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/625362839\",\n \"returnLineItems\": [{\"fulfillmentLineItemId\"=>\"gid://shopify/FulfillmentLineItem/820022594\", \"quantity\"=>1, \"returnReason\"=>\"WRONG_ITEM\", \"customerNote\"=>\"Sorry, I ordered the wrong item. Could I get a refund or store credit?\"}]\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation ReturnRequest($input: ReturnRequestInput!) {\n returnRequest(input: $input) {\n userErrors {\n field\n message\n }\n return {\n id\n status\n returnLineItems(first: 1) {\n edges {\n node {\n id\n returnReason\n customerNote\n }\n }\n }\n order {\n id\n }\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/625362839\",\n \"returnLineItems\": [\n {\n \"fulfillmentLineItemId\": \"gid://shopify/FulfillmentLineItem/820022594\",\n \"quantity\": 1,\n \"returnReason\": \"WRONG_ITEM\",\n \"customerNote\": \"Sorry, I ordered the wrong item. Could I get a refund or store credit?\"\n }\n ]\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation ReturnRequest($input: ReturnRequestInput!) {\n returnRequest(input: $input) {\n userErrors {\n field\n message\n }\n return {\n id\n status\n returnLineItems(first: 1) {\n edges {\n node {\n id\n returnReason\n customerNote\n }\n }\n }\n order {\n id\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"orderId\" => \"gid://shopify/Order/625362839\",\n \"returnLineItems\" => [{\"fulfillmentLineItemId\"=>\"gid://shopify/FulfillmentLineItem/820022594\", \"quantity\"=>1, \"returnReason\"=>\"WRONG_ITEM\", \"customerNote\"=>\"Sorry, I ordered the wrong item. Could I get a refund or store credit?\"}],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The input fields for requesting a return.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ReturnRequestInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ReturnRequestInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"orderId\":\"gid://shopify/Order/625362839\",\"returnLineItems\":[{\"fulfillmentLineItemId\":\"gid://shopify/FulfillmentLineItem/820022594\",\"quantity\":1,\"returnReason\":\"WRONG_ITEM\",\"customerNote\":\"Sorry, I ordered the wrong item. Could I get a refund or store credit?\"}]}",
"typeKind": "MUTATION"
}
]
}
]