Refund

Represents a refund scoped to an nautical order, a seller order, or a seller order line

type Refund implements Node, ObjectWithMetadata {
  createdAt: DateTime!
  updatedAt: DateTime!
  description: String!
  descriptionHtml: String!
  id: ID!
  lines(
    offset: Int
    before: String
    after: String
    first: Int
    last: Int
  ): RefundLineCountableConnection!
  payments(
    offset: Int
    before: String
    after: String
    first: Int
    last: Int
  ): RefundPaymentCountableConnection!
  privateMetadata: [MetadataItem!]!
  metadata: [MetadataItem!]!
  buyer: User
  externalId: String
  name: String!
  order: NauticalOrder!
  status: RefundStatusEnum!
  token: String!
  refundType: RefundTypeEnum!
}

Show more ↓

Fields

Refund.createdAt ● DateTime! non-null scalar

Refund.updatedAt ● DateTime! non-null scalar

Refund.description ● String! non-null scalar

Refund.descriptionHtml ● String! non-null scalar

Refund.id ● ID! non-null scalar

The ID of the object

Refund.lines ● RefundLineCountableConnection! non-null object

Refund.lines.offset ● Int scalar

Refund.lines.before ● String scalar

Refund.lines.after ● String scalar

Refund.lines.first ● Int scalar

Refund.lines.last ● Int scalar

Refund.payments ● RefundPaymentCountableConnection! non-null object

Refund.payments.offset ● Int scalar

Refund.payments.before ● String scalar

Refund.payments.after ● String scalar

Refund.payments.first ● Int scalar

Refund.payments.last ● Int scalar

Refund.privateMetadata ● [MetadataItem!]! non-null object

List of private metadata items.Requires proper staff permissions to access.

Refund.metadata ● [MetadataItem!]! non-null object

List of public metadata items. Can be accessed without permissions.

Refund.buyer ● User object

The buyer who is receiving the refund. This may be NULL in the case of refunds issued against anonymous orders

Refund.externalId ● String scalar

Optional external ID which can be used to synchronize Nautical refunds to data in an external system

Refund.name ● String! non-null scalar

Human readable name of the refund

Refund.order ● NauticalOrder! non-null object

The order that this refund is against

Refund.status ● RefundStatusEnum! non-null enum

Status of the refund

Refund.token ● String! non-null scalar

Unique UUID associated with the refund

Refund.refundType ● RefundTypeEnum! non-null enum

Type of the refund: manual or order line. An order line refund is scoped to either an OrderLine or an Order with the lineType of Shipping. A manual refund is scoped either to a BuyerOrder or a SellerOrder with any lineType besides Shipping

Interfaces

Node interface

An object with an ID

ObjectWithMetadata interface

Returned By

refund query

Member Of

InvoiceRequest object ● JournalEntry object ● NauticalOrder object ● RefundCountableEdge object ● RefundCreate object ● RefundLine object ● RefundLinesAdd object ● RefundLinesUpdate object ● RefundPayment object ● RefundPaymentsAdd object ● RefundPaymentsUpdate object ● RefundUpdate object