VendorPayout

No description

type VendorPayout implements Node, ObjectWithMetadata {
  id: ID!
  created: DateTime!
  updated: DateTime!
  gateway: String!
  payout: Payout!
  seller: Seller!
  included: Boolean!
  status: VendorPayoutStatus!
  statusMessage: String
  ledgerVersion: BigInt!
  refundLines(
    offset: Int
    before: String
    after: String
    first: Int
    last: Int
  ): RefundLineCountableConnection!
  privateMetadata: [MetadataItem!]!
  metadata: [MetadataItem!]!
  adjustment: Money!
  commissionMoney: Money!
  discountsMoney: Money!
  events(
    eventTypes: [VendorPayoutEventsEnum!]
  ): [VendorPayoutEvent!]!
  fees: Money!
  netSales: Money!
  payable: Money!
  refund: Money!
  shippingMoney: Money!
  subtotal: Money!
  total: Money!
  adjustmentAmount: Decimal! @deprecated
  average: Decimal! @deprecated
  commission: Decimal! @deprecated
  currency: String! @deprecated
  discounts: Decimal! @deprecated
  feeAmount: Decimal! @deprecated
  net: Decimal! @deprecated
  payoutAmount: Decimal! @deprecated
  refundAmount: Decimal! @deprecated
  shipping: Decimal! @deprecated
  volumeDiscounts: Decimal! @deprecated
  orders(
    before: String
    after: String
    first: Int
    last: Int
  ): OrderCountableConnection!
}

Show more ↓

Fields

VendorPayout.id ● ID! non-null scalar

The ID of the object

VendorPayout.created ● DateTime! non-null scalar

VendorPayout.updated ● DateTime! non-null scalar

VendorPayout.gateway ● String! non-null scalar

VendorPayout.payout ● Payout! non-null object

VendorPayout.seller ● Seller! non-null object

VendorPayout.included ● Boolean! non-null scalar

VendorPayout.status ● VendorPayoutStatus! non-null enum

VendorPayout.statusMessage ● String scalar

VendorPayout.ledgerVersion ● BigInt! non-null scalar

VendorPayout.refundLines ● RefundLineCountableConnection! non-null object

VendorPayout.refundLines.offset ● Int scalar

VendorPayout.refundLines.before ● String scalar

VendorPayout.refundLines.after ● String scalar

VendorPayout.refundLines.first ● Int scalar

VendorPayout.refundLines.last ● Int scalar

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

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

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

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

VendorPayout.adjustment ● Money! non-null object

VendorPayout.commissionMoney ● Money! non-null object

VendorPayout.discountsMoney ● Money! non-null object

VendorPayout.events ● [VendorPayoutEvent!]! non-null object

List of events associated with the vendor payout (sorted from newest to latest)

VendorPayout.events.eventTypes ● [VendorPayoutEventsEnum!] list enum

Optional filter by event types

VendorPayout.fees ● Money! non-null object

VendorPayout.netSales ● Money! non-null object

VendorPayout.payable ● Money! non-null object

VendorPayout.refund ● Money! non-null object

VendorPayout.shippingMoney ● Money! non-null object

VendorPayout.subtotal ● Money! non-null object

VendorPayout.total ● Money! non-null object

VendorPayout.adjustmentAmount ● Decimal! deprecated non-null scalar

DEPRECATED

This will be removed on August 6, 2025. Use the adjustment field instead.

VendorPayout.average ● Decimal! deprecated non-null scalar

DEPRECATED

This will be removed on August 6, 2025.

VendorPayout.commission ● Decimal! deprecated non-null scalar

DEPRECATED

This will be removed on August 6, 2025. Use the commissionMoney field instead.

VendorPayout.currency ● String! deprecated non-null scalar

DEPRECATED

This will be removed on August 6, 2025.

VendorPayout.discounts ● Decimal! deprecated non-null scalar

DEPRECATED

This will be removed on August 6, 2025. Use the discountsMoney field instead.

VendorPayout.feeAmount ● Decimal! deprecated non-null scalar

DEPRECATED

This will be removed on August 6, 2025. Use the fees field instead.

VendorPayout.net ● Decimal! deprecated non-null scalar

DEPRECATED

This will be removed on August 6, 2025. Use the netSales field instead.

VendorPayout.payoutAmount ● Decimal! deprecated non-null scalar

DEPRECATED

This will be removed on August 6, 2025. Use the payable field instead.

VendorPayout.refundAmount ● Decimal! deprecated non-null scalar

DEPRECATED

This will be removed on August 6, 2025. Use the refund field instead.

VendorPayout.shipping ● Decimal! deprecated non-null scalar

DEPRECATED

This will be removed on August 6, 2025. Use the shippingMoney field instead.

VendorPayout.volumeDiscounts ● Decimal! deprecated non-null scalar

DEPRECATED

This will be removed on August 6, 2025.

VendorPayout.orders ● OrderCountableConnection! non-null object

List of orders included in this vendor payout

VendorPayout.orders.before ● String scalar

Return the elements in the list that come before the specified cursor.

VendorPayout.orders.after ● String scalar

Return the elements in the list that come after the specified cursor.

VendorPayout.orders.first ● Int scalar

Return the first n elements from the list.

VendorPayout.orders.last ● Int scalar

Return the last n elements from the list.

Interfaces

Node interface

An object with an ID

ObjectWithMetadata interface

Returned By

vendorPayout query

Member Of

JournalEntry object ● Order object ● OrderPayoutSummary object ● OrderVendorReportType object ● SingleVendorReportType object ● VendorPayoutCountableEdge object ● VendorPayoutCreate object ● VendorPayoutNoteAdd object ● VendorPayoutNoteUpdate object ● VendorPayoutStatusUpdate object