Anchor to section titled 'undefined'refund
refund
mutation
2024-07
Requires orders access scope, marketplace access scope or buyer access scope.
Creates a refund.
Anchor to section titled 'Arguments'
Arguments
The input fields that are used in the mutation for creating a refund.
Was this section helpful?
Anchor to section titled 'RefundCreatePayload returns'
RefundCreatePayload returns
The order associated with the created refund.
The created refund.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: refundCreate
Query Reference for MUTATION: refundCreate
"mutation refundCreate($input: RefundInput!) {\n refundCreate(input: $input) {\n order {\n # Order fields\n }\n refund {\n # Refund fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: refundCreate
"{\n \"input\": {\n \"currency\": \"AED\",\n \"note\": \"<your-note>\",\n \"notify\": true,\n \"orderId\": \"gid://shopify/<objectName>/10079785100\",\n \"refundDuties\": [\n {\n \"dutyId\": \"gid://shopify/<objectName>/10079785100\",\n \"refundType\": \"FULL\"\n }\n ],\n \"refundLineItems\": [\n {\n \"lineItemId\": \"gid://shopify/<objectName>/10079785100\",\n \"locationId\": \"gid://shopify/<objectName>/10079785100\",\n \"quantity\": 1,\n \"restockType\": \"CANCEL\"\n }\n ],\n \"shipping\": {\n \"amount\": \"100.57\",\n \"fullRefund\": true\n },\n \"transactions\": [\n {\n \"amount\": \"100.57\",\n \"gateway\": \"<your-gateway>\",\n \"kind\": \"AUTHORIZATION\",\n \"orderId\": \"gid://shopify/<objectName>/10079785100\",\n \"parentId\": \"gid://shopify/<objectName>/10079785100\"\n }\n ]\n }\n}"Schema Reference for MUTATION: refundCreate
"input RefundInput {\n currency: CurrencyCode\n note: String\n notify: Boolean\n orderId: ID!\n refundDuties: [RefundDutyInput!]\n refundLineItems: [RefundLineItemInput!]\n shipping: ShippingRefundInput\n transactions: [OrderTransactionInput!]\n}\n\ninput RefundDutyInput {\n dutyId: ID!\n refundType: RefundDutyRefundType\n}\n\ninput RefundLineItemInput {\n lineItemId: ID!\n locationId: ID\n quantity: Int!\n restockType: RefundLineItemRestockType\n}\n\ninput ShippingRefundInput {\n amount: Money\n fullRefund: Boolean\n}\n\ninput OrderTransactionInput {\n amount: Money!\n gateway: String!\n kind: OrderTransactionKind!\n orderId: ID!\n parentId: ID\n}\n"Display Examples for MUTATION: refundCreate
[
{
"example": {
"type_name": "refundcreate",
"title": "Create a refund with a note and transaction, then return the total refund amount across all transactions",
"query_string": "mutation M($input: RefundInput!) {\n refundCreate(input: $input) {\n userErrors {\n field\n message\n }\n refund {\n id\n note\n totalRefundedSet {\n presentmentMoney {\n amount\n }\n }\n }\n }\n}",
"variables": {
"input": {
"orderId": "gid://shopify/Order/734509473",
"note": "Want to exchange for a different item",
"refundLineItems": [
{
"lineItemId": "gid://shopify/LineItem/25746870",
"quantity": 2
}
],
"transactions": [
{
"orderId": "gid://shopify/Order/734509473",
"gateway": "foo",
"kind": "REFUND",
"amount": "10.0",
"parentId": "gid://shopify/OrderTransaction/723599266"
}
]
}
},
"response": {
"data": {
"refundCreate": {
"userErrors": [],
"refund": {
"id": "gid://shopify/Refund/929361464",
"note": "Want to exchange for a different item",
"totalRefundedSet": {
"presentmentMoney": {
"amount": "10.0"
}
}
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/returns/test/unit/graph_api/admin/mutations/refund_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation M($input: RefundInput!) { refundCreate(input: $input) { userErrors { field message } refund { id note totalRefundedSet { presentmentMoney { amount } } } } }\",\n \"variables\": {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/734509473\",\n \"note\": \"Want to exchange for a different item\",\n \"refundLineItems\": [\n {\n \"lineItemId\": \"gid://shopify/LineItem/25746870\",\n \"quantity\": 2\n }\n ],\n \"transactions\": [\n {\n \"orderId\": \"gid://shopify/Order/734509473\",\n \"gateway\": \"foo\",\n \"kind\": \"REFUND\",\n \"amount\": \"10.0\",\n \"parentId\": \"gid://shopify/OrderTransaction/723599266\"\n }\n ]\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation M($input: RefundInput!) {\n refundCreate(input: $input) {\n userErrors {\n field\n message\n }\n refund {\n id\n note\n totalRefundedSet {\n presentmentMoney {\n amount\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/734509473\",\n \"note\": \"Want to exchange for a different item\",\n \"refundLineItems\": [\n {\n \"lineItemId\": \"gid://shopify/LineItem/25746870\",\n \"quantity\": 2\n }\n ],\n \"transactions\": [\n {\n \"orderId\": \"gid://shopify/Order/734509473\",\n \"gateway\": \"foo\",\n \"kind\": \"REFUND\",\n \"amount\": \"10.0\",\n \"parentId\": \"gid://shopify/OrderTransaction/723599266\"\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 M($input: RefundInput!) {\n refundCreate(input: $input) {\n userErrors {\n field\n message\n }\n refund {\n id\n note\n totalRefundedSet {\n presentmentMoney {\n amount\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/734509473\",\n \"note\": \"Want to exchange for a different item\",\n \"refundLineItems\": [{\"lineItemId\"=>\"gid://shopify/LineItem/25746870\", \"quantity\"=>2}],\n \"transactions\": [{\"orderId\"=>\"gid://shopify/Order/734509473\", \"gateway\"=>\"foo\", \"kind\"=>\"REFUND\", \"amount\"=>\"10.0\", \"parentId\"=>\"gid://shopify/OrderTransaction/723599266\"}]\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 M($input: RefundInput!) {\n refundCreate(input: $input) {\n userErrors {\n field\n message\n }\n refund {\n id\n note\n totalRefundedSet {\n presentmentMoney {\n amount\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/734509473\",\n \"note\": \"Want to exchange for a different item\",\n \"refundLineItems\": [\n {\n \"lineItemId\": \"gid://shopify/LineItem/25746870\",\n \"quantity\": 2\n }\n ],\n \"transactions\": [\n {\n \"orderId\": \"gid://shopify/Order/734509473\",\n \"gateway\": \"foo\",\n \"kind\": \"REFUND\",\n \"amount\": \"10.0\",\n \"parentId\": \"gid://shopify/OrderTransaction/723599266\"\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 M($input: RefundInput!) {\n refundCreate(input: $input) {\n userErrors {\n field\n message\n }\n refund {\n id\n note\n totalRefundedSet {\n presentmentMoney {\n amount\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"orderId\" => \"gid://shopify/Order/734509473\",\n \"note\" => \"Want to exchange for a different item\",\n \"refundLineItems\" => [{\"lineItemId\"=>\"gid://shopify/LineItem/25746870\", \"quantity\"=>2}],\n \"transactions\" => [{\"orderId\"=>\"gid://shopify/Order/734509473\", \"gateway\"=>\"foo\", \"kind\"=>\"REFUND\", \"amount\"=>\"10.0\", \"parentId\"=>\"gid://shopify/OrderTransaction/723599266\"}],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The input fields that are used in the mutation for creating a refund.",
"type": {
"kind": "INPUT_OBJECT",
"name": "RefundInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "RefundInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"orderId\":\"gid://shopify/Order/734509473\",\"note\":\"Want to exchange for a different item\",\"refundLineItems\":[{\"lineItemId\":\"gid://shopify/LineItem/25746870\",\"quantity\":2}],\"transactions\":[{\"orderId\":\"gid://shopify/Order/734509473\",\"gateway\":\"foo\",\"kind\":\"REFUND\",\"amount\":\"10.0\",\"parentId\":\"gid://shopify/OrderTransaction/723599266\"}]}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "refundcreate",
"title": "Create a refund with shipping partially refunded. Then, return the total refund amount and information about the first two transactions.",
"description": "Shipping refunds are included in the `REFUND` transaction amount.Transaction amounts can be calculated with the use of a `SuggestedRefund`.",
"query_string": "mutation M($input: RefundInput!) {\n refundCreate(input: $input) {\n userErrors {\n field\n message\n }\n refund {\n id\n totalRefundedSet {\n presentmentMoney {\n amount\n }\n }\n transactions(first: 2) {\n edges {\n node {\n amountSet {\n presentmentMoney {\n amount\n }\n }\n status\n }\n }\n }\n }\n }\n}",
"query_arguments": {
"first": 2
},
"variables": {
"input": {
"orderId": "gid://shopify/Order/734509473",
"transactions": [
{
"orderId": "gid://shopify/Order/734509473",
"parentId": "gid://shopify/OrderTransaction/723599266",
"kind": "REFUND",
"gateway": "foo",
"amount": "16.99"
}
],
"shipping": {
"amount": "6.99"
}
}
},
"response": {
"data": {
"refundCreate": {
"userErrors": [],
"refund": {
"id": "gid://shopify/Refund/929361463",
"totalRefundedSet": {
"presentmentMoney": {
"amount": "16.99"
}
},
"transactions": {
"edges": [
{
"node": {
"amountSet": {
"presentmentMoney": {
"amount": "16.99"
}
},
"status": "SUCCESS"
}
}
]
}
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/returns/test/unit/graph_api/admin/mutations/refund_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation M($input: RefundInput!) { refundCreate(input: $input) { userErrors { field message } refund { id totalRefundedSet { presentmentMoney { amount } } transactions(first: 2) { edges { node { amountSet { presentmentMoney { amount } } status } } } } } }\",\n \"variables\": {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/734509473\",\n \"transactions\": [\n {\n \"orderId\": \"gid://shopify/Order/734509473\",\n \"parentId\": \"gid://shopify/OrderTransaction/723599266\",\n \"kind\": \"REFUND\",\n \"gateway\": \"foo\",\n \"amount\": \"16.99\"\n }\n ],\n \"shipping\": {\n \"amount\": \"6.99\"\n }\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation M($input: RefundInput!) {\n refundCreate(input: $input) {\n userErrors {\n field\n message\n }\n refund {\n id\n totalRefundedSet {\n presentmentMoney {\n amount\n }\n }\n transactions(first: 2) {\n edges {\n node {\n amountSet {\n presentmentMoney {\n amount\n }\n }\n status\n }\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/734509473\",\n \"transactions\": [\n {\n \"orderId\": \"gid://shopify/Order/734509473\",\n \"parentId\": \"gid://shopify/OrderTransaction/723599266\",\n \"kind\": \"REFUND\",\n \"gateway\": \"foo\",\n \"amount\": \"16.99\"\n }\n ],\n \"shipping\": {\n \"amount\": \"6.99\"\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 M($input: RefundInput!) {\n refundCreate(input: $input) {\n userErrors {\n field\n message\n }\n refund {\n id\n totalRefundedSet {\n presentmentMoney {\n amount\n }\n }\n transactions(first: 2) {\n edges {\n node {\n amountSet {\n presentmentMoney {\n amount\n }\n }\n status\n }\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/734509473\",\n \"transactions\": [{\"orderId\"=>\"gid://shopify/Order/734509473\", \"parentId\"=>\"gid://shopify/OrderTransaction/723599266\", \"kind\"=>\"REFUND\", \"gateway\"=>\"foo\", \"amount\"=>\"16.99\"}],\n \"shipping\": {\n \"amount\": \"6.99\"\n }\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 M($input: RefundInput!) {\n refundCreate(input: $input) {\n userErrors {\n field\n message\n }\n refund {\n id\n totalRefundedSet {\n presentmentMoney {\n amount\n }\n }\n transactions(first: 2) {\n edges {\n node {\n amountSet {\n presentmentMoney {\n amount\n }\n }\n status\n }\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/734509473\",\n \"transactions\": [\n {\n \"orderId\": \"gid://shopify/Order/734509473\",\n \"parentId\": \"gid://shopify/OrderTransaction/723599266\",\n \"kind\": \"REFUND\",\n \"gateway\": \"foo\",\n \"amount\": \"16.99\"\n }\n ],\n \"shipping\": {\n \"amount\": \"6.99\"\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 M($input: RefundInput!) {\n refundCreate(input: $input) {\n userErrors {\n field\n message\n }\n refund {\n id\n totalRefundedSet {\n presentmentMoney {\n amount\n }\n }\n transactions(first: 2) {\n edges {\n node {\n amountSet {\n presentmentMoney {\n amount\n }\n }\n status\n }\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"orderId\" => \"gid://shopify/Order/734509473\",\n \"transactions\" => [{\"orderId\"=>\"gid://shopify/Order/734509473\", \"parentId\"=>\"gid://shopify/OrderTransaction/723599266\", \"kind\"=>\"REFUND\", \"gateway\"=>\"foo\", \"amount\"=>\"16.99\"}],\n \"shipping\" => [\n \"amount\" => \"6.99\",\n ],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The input fields that are used in the mutation for creating a refund.",
"type": {
"kind": "INPUT_OBJECT",
"name": "RefundInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "RefundInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"orderId\":\"gid://shopify/Order/734509473\",\"transactions\":[{\"orderId\":\"gid://shopify/Order/734509473\",\"parentId\":\"gid://shopify/OrderTransaction/723599266\",\"kind\":\"REFUND\",\"gateway\":\"foo\",\"amount\":\"16.99\"}],\"shipping\":{\"amount\":\"6.99\"}}",
"typeKind": "MUTATION"
}
]
}
]