Refund

Also in this section

Required access

read_orders access scope

Represents a refund of items or transactions in an order.

Show definition

# Represents a refund of items or transactions in an order.
type Refund implements Node {
  # Globally unique identifier.
  id: ID!

  # When the refund was created.
  createdAt: DateTime

  # Note associated with the refund.
  note: String

  # The RefundLineItem resources attached to the refund.
  refundLineItems(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false
  ): RefundLineItemConnection!

  # Whether the RefundLineItem resources were restocked when the refund was created.
  restocked: Boolean!

  # Total amount refunded across all the transactions for this refund.
  totalRefunded: MoneyV2!

  # Transactions associated with the refund.
  transactions(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false
  ): OrderTransactionConnection!

  # When the refund was last updated.
  updatedAt: DateTime!
}

Implements

• Node

Connections

refundLineItems   (RefundLineItemConnection!)

The RefundLineItem resources attached to the refund.

Argument	Type	Default	Description
after	String		Returns the elements that come after the specified cursor.
before	String		Returns the elements that come before the specified cursor.
first	Int		Returns up to the first n elements from the list.
last	Int		Returns up to the last n elements from the list.
reverse	Boolean	false	Reverse the order of the underlying list.

transactions   (OrderTransactionConnection!)

Transactions associated with the refund.

Argument	Type	Default	Description
after	String		Returns the elements that come after the specified cursor.
before	String		Returns the elements that come before the specified cursor.
first	Int		Returns up to the first n elements from the list.
last	Int		Returns up to the last n elements from the list.
reverse	Boolean	false	Reverse the order of the underlying list.

Fields

createdAt   (DateTime)

When the refund was created.

id   (ID!)

Globally unique identifier.

note   (String)

Note associated with the refund.

restocked   (Boolean!)

Whether the RefundLineItem resources were restocked when the refund was created.

totalRefunded   (MoneyV2!)

Total amount refunded across all the transactions for this refund.

updatedAt   (DateTime!)

When the refund was last updated.