refund
query

Choose a version:

Requires read_orders access scope or read_marketplace_orders access scope.

Returns a Refund resource by ID.

Anchor to section titled 'Arguments'

Arguments

Anchor to id id ID! required: The ID of the Refund to return.

Was this section helpful?

Anchor to section titled 'Refund possible returns'

Refund possible returns

Anchor to Refund Refund Refund: The record of the line items and transactions that were refunded to a customer, along with restocking instructions for refunded line items.

Was this section helpful?

Code examples for QUERY: refund

Query Reference for QUERY: refund

"{\n  refund(id) {\n    # Refund fields\n  }\n}"

Input Reference for QUERY: refund

Schema Reference for QUERY: refund

Display Examples for QUERY: refund

[
  {
    "example": {
      "type_name": "refund",
      "title": "Get refund duties",
      "description": "The following query retrieves a refund by its ID and returns the refund duties.\n",
      "query_string": "query refund($input: ID!) {\n  refund(id: $input) {\n    duties {\n      originalDuty {\n        countryCodeOfOrigin\n      }\n      amountSet {\n        shopMoney {\n          amount\n        }\n      }\n    }\n  }\n}",
      "variables": {
        "input": "gid://shopify/Refund/850600470"
      },
      "response": {
        "data": {
          "refund": {
            "duties": [
              {
                "originalDuty": {
                  "countryCodeOfOrigin": "US"
                },
                "amountSet": {
                  "shopMoney": {
                    "amount": "6.0"
                  }
                }
              }
            ]
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/returns/test/unit/graph_api/admin/refund_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\": \"query refund($input: ID!) { refund(id: $input) { duties { originalDuty { countryCodeOfOrigin } amountSet { shopMoney { amount } } } } }\",\n \"variables\": {\n    \"input\": \"gid://shopify/Refund/850600470\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query refund($input: ID!) {\n    refund(id: $input) {\n      duties {\n        originalDuty {\n          countryCodeOfOrigin\n        }\n        amountSet {\n          shopMoney {\n            amount\n          }\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": \"gid://shopify/Refund/850600470\"\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  query refund($input: ID!) {\n    refund(id: $input) {\n      duties {\n        originalDuty {\n          countryCodeOfOrigin\n        }\n        amountSet {\n          shopMoney {\n            amount\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": \"gid://shopify/Refund/850600470\"\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\": `query refund($input: ID!) {\n      refund(id: $input) {\n        duties {\n          originalDuty {\n            countryCodeOfOrigin\n          }\n          amountSet {\n            shopMoney {\n              amount\n            }\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": \"gid://shopify/Refund/850600470\"\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  query refund($input: ID!) {\n    refund(id: $input) {\n      duties {\n        originalDuty {\n          countryCodeOfOrigin\n        }\n        amountSet {\n          shopMoney {\n            amount\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => \"gid://shopify/Refund/850600470\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "arguments",
    "inputVariableEntries": []
  },
  {
    "example": {
      "type_name": "refund",
      "title": "Get the total refunded amount",
      "description": "The following query retrieves a refund by its ID and returns the total refunded amount.\n",
      "query_string": "query refund($input: ID!) {\n  refund(id: $input) {\n    totalRefundedSet {\n      shopMoney {\n        amount\n        currencyCode\n      }\n    }\n  }\n}",
      "variables": {
        "input": "gid://shopify/Refund/196417871"
      },
      "response": {
        "data": {
          "refund": {
            "totalRefundedSet": {
              "shopMoney": {
                "amount": "5.75",
                "currencyCode": "USD"
              }
            }
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/returns/test/unit/graph_api/admin/refund_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\": \"query refund($input: ID!) { refund(id: $input) { totalRefundedSet { shopMoney { amount currencyCode } } } }\",\n \"variables\": {\n    \"input\": \"gid://shopify/Refund/196417871\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query refund($input: ID!) {\n    refund(id: $input) {\n      totalRefundedSet {\n        shopMoney {\n          amount\n          currencyCode\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": \"gid://shopify/Refund/196417871\"\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  query refund($input: ID!) {\n    refund(id: $input) {\n      totalRefundedSet {\n        shopMoney {\n          amount\n          currencyCode\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": \"gid://shopify/Refund/196417871\"\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\": `query refund($input: ID!) {\n      refund(id: $input) {\n        totalRefundedSet {\n          shopMoney {\n            amount\n            currencyCode\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": \"gid://shopify/Refund/196417871\"\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  query refund($input: ID!) {\n    refund(id: $input) {\n      totalRefundedSet {\n        shopMoney {\n          amount\n          currencyCode\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => \"gid://shopify/Refund/196417871\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "arguments",
    "inputVariableEntries": []
  }
]

refundquery

Arguments

Refund possible returns

refund
query