Refund object

Represents a refund of items or transactions in an order.

Required access

read_orders access scope.

On this page

Connections

  • refundLineItems ([RefundLineItemConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/refundlineitem))
    The RefundLineItem resources attached to the refund.
Argument Description
after
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come after the specified cursor.
before
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come before the specified cursor.
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the first n elements from the list.
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the last n elements from the list.
reverse
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Reverse the order of the underlying list.
Default value: false
  • transactions ([OrderTransactionConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordertransaction))
    Transactions associated with the refund.
Argument Description
after
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come after the specified cursor.
before
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come before the specified cursor.
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the first n elements from the list.
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the last n elements from the list.
reverse
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Reverse the order of the underlying list.
Default value: false

Fields

  • createdAt ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    When the refund was created.
  • duties ([[RefundDuty!]](https://shopify.dev/docs/admin-api/graphql/reference/orders/refundduty))
    A list of the order’s refunded duties.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier.
  • legacyResourceId ([UnsignedInt64!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#unsignedint64-2021-01))
    The ID of the corresponding resource in the REST Admin API.
  • note ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    Note associated with the refund.
  • order ([Order!](https://shopify.dev/docs/admin-api/graphql/reference/orders/order))
    The order associated with the refund.
  • totalRefundedSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
    Total amount refunded across all the transactions for this refund in shop and presentment currencies.
  • updatedAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    When the refund was last updated.

Types that return Refund

  • [Order.refunds](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#refunds-2021-01)
  • [QueryRoot.refund](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#refund-2021-01)

Mutations for Refund

Implements

  • [LegacyInteroperability](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/legacyinteroperability)
  • [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)

Deprecated fields

  • totalRefunded ([MoneyV2!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2)) DEPRECATED
    Total amount refunded across all the transactions for this refund.
    Deprecation warning
    Use totalRefundedSet instead