Refund

Version 2019-04 (latest)

Represents a refund of items or transactions in an order.

Required access

read_orders access scope

Show definition
"""
Represents a refund of items or transactions in an order.
"""
type Refund implements LegacyInteroperability & Node {
  """
  When the refund was created.
  """
  createdAt: DateTime
  """
  Globally unique identifier.
  """
  id: ID!
  """
  The ID of the corresponding resource in the REST Admin API.
  """
  legacyResourceId: UnsignedInt64!
  """
  Note associated with the refund.
  """
  note: String
  """
  The RefundLineItem resources attached to the refund.
  """
  refundLineItems(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    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!
  """
  Total amount refunded across all the transactions for this refund in shop and presentment currencies.
  """
  totalRefundedSet: MoneyBag!
  """
  Transactions associated with the refund.
  """
  transactions(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): OrderTransactionConnection!
  """
  When the refund was last updated.
  """
  updatedAt: DateTime!
}

Implements

Connections

refundLineItems (RefundLineItemConnection!)

The RefundLineItem resources attached to the refund.

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 )

Reverse the order of the underlying list.
Default value: true

transactions (OrderTransactionConnection!)

Transactions associated with the refund.

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 )

Reverse the order of the underlying list.
Default value: true

Fields

createdAt (DateTime)

When the refund was created.

id (ID!)

Globally unique identifier.

legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.

note (String)

Note associated with the refund.

totalRefundedSet (MoneyBag!)

Total amount refunded across all the transactions for this refund in shop and presentment currencies.

updatedAt (DateTime!)

When the refund was last updated.

Deprecated fields

Show/Hide
restocked (Boolean!) deprecated

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

Deprecation warning

Use restockType on the RefundLineItem resource instead.

totalRefunded (MoneyV2!) deprecated

Total amount refunded across all the transactions for this refund.

Deprecation warning

Use totalRefundedSet instead

Sign up for a Partner account to get started.

Sign up