Refund

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!

  # Returns the Date/Time when the Refund resource was created.
  createdAt: DateTime

  # Returns the note attached to the Refund resource on creation.
  note: String

  # Returns the RefundLineItem resources attached to the Refund resource.
  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 upon the Refund resource's creation.
  restocked: Boolean!

  # Returns a list of Transaction resources involved in creation of the Refund resource.
  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!

  # Returns the Date/Time when the Refund resource was last updated.
  updatedAt: DateTime!
}

Implements

Connections

refundLineItems   (RefundLineItemConnection!)

Returns the RefundLineItem resources attached to the Refund resource.

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!)

Returns a list of Transaction resources involved in creation of the Refund resource.

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)

Returns the Date/Time when the Refund resource was created.

id   (ID!)

Globally unique identifier.

note   (String)

Returns the note attached to the Refund resource on creation.

restocked   (Boolean!)

Whether the RefundLineItem resources were restocked upon the Refund resource's creation.

updatedAt   (DateTime!)

Returns the Date/Time when the Refund resource was last updated.