Choose a version:

refund

query

Requires read_orders access scope or read_marketplace_orders access scope.

Returns a Refund resource by ID.

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

Refund

•

Refund

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

createdAt• DateTime: The date and time when the refund was created.
duties• [RefundDuty!]: A list of the refunded duties as part of this refund.
id• ID! non-null: A globally-unique ID.
legacyResourceId• UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
note• String: The optional note associated with the refund.
order• Order! non-null: The order associated with the refund.
refundLineItems • RefundLineItemConnection! non-null: The RefundLineItem resources attached to the refund.
refundShippingLines • RefundShippingLineConnection! non-null: The RefundShippingLine resources attached to the refund.
return• Return: The return associated with the refund.
staffMember• StaffMember: The staff member who created the refund.
totalRefundedSet• MoneyBag! non-null: The total amount across all transactions for the refund, in shop and presentment currencies.
transactions • OrderTransactionConnection! non-null: The transactions associated with the refund.
updatedAt• DateTime! non-null: The date and time when the refund was updated.
totalRefunded• MoneyV2! non-null: The total amount across all transactions for the refund.

Was this section helpful?

Get refund duties
Get the total refunded amount
Retrieves a specific refund

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query refund($input: ID!) {

refund(id: $input) {

duties {

originalDuty {

countryCodeOfOrigin

}

amountSet {

shopMoney {

amount

}

}`,

{

variables: {

"input": "gid://shopify/Refund/850600470"

);

const data = await response.json();

query refund($input: ID!) {
  refund(id: $input) {
    duties {
      originalDuty {
        countryCodeOfOrigin
      }
      amountSet {
        shopMoney {
          amount
        }
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query refund($input: ID!) { refund(id: $input) { duties { originalDuty { countryCodeOfOrigin } amountSet { shopMoney { amount } } } } }",
 "variables": {
    "input": "gid://shopify/Refund/850600470"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query refund($input: ID!) {
    refund(id: $input) {
      duties {
        originalDuty {
          countryCodeOfOrigin
        }
        amountSet {
          shopMoney {
            amount
          }
        }
      }
    }
  }`,
  {
    variables: {
      "input": "gid://shopify/Refund/850600470"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query refund($input: ID!) {
      refund(id: $input) {
        duties {
          originalDuty {
            countryCodeOfOrigin
          }
          amountSet {
            shopMoney {
              amount
            }
          }
        }
      }
    }`,
    "variables": {
      "input": "gid://shopify/Refund/850600470"
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query refund($input: ID!) {
    refund(id: $input) {
      duties {
        originalDuty {
          countryCodeOfOrigin
        }
        amountSet {
          shopMoney {
            amount
          }
        }
      }
    }
  }
QUERY

variables = {
  "input": "gid://shopify/Refund/850600470"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"input": "gid://shopify/Refund/850600470"

}

Response

JSON

{

"refund": {

"duties": [

{

"originalDuty": {

"countryCodeOfOrigin": "US"

"amountSet": {

"shopMoney": {

"amount": "6.0"

}

]

}