VendorPayout
Represents a vendor payout.
type VendorPayout implements Node, ObjectWithMetadata {
id: ID!
metadata: [MetadataItem!]!
privateMetadata: [MetadataItem!]!
status: VendorPayoutStatus!
created: DateTime!
updated: DateTime!
gateway: String!
included: Boolean!
statusMessage: String
adjustmentAmount: Float! @deprecated
average: Float! @deprecated
commission: Float! @deprecated
currency: String! @deprecated
discounts: Float! @deprecated
feeAmount: Float! @deprecated
net: Float! @deprecated
payoutAmount: Float! @deprecated
refundAmount: Float! @deprecated
shipping: Float! @deprecated
volumeDiscounts: Float! @deprecated
ledgerVersion: BigInt!
adjustment: Money!
commissionMoney: Money!
discountsMoney: Money!
fees: Money!
netSales: Money!
payable: Money!
refund: Money!
shippingMoney: Money!
subtotal: Money!
total: Money!
seller: Seller!
payout: Payout!
refundLines(
before: String
after: String
first: Int
last: Int
): RefundLineCountableConnection!
events(
eventTypes: [VendorPayoutEventsEnum!]
): [VendorPayoutEvent!]!
orders(
before: String
after: String
first: Int
last: Int
): OrderCountableConnection!
}
Fields
VendorPayout.id ● ID! non-null scalar
The Globally Unique ID of this object
VendorPayout.metadata ● [MetadataItem!]! non-null object
List of public metadata items. Can be accessed without permissions.
VendorPayout.privateMetadata ● [MetadataItem!]! non-null object
List of private metadata items. Requires proper staff permissions to access.
VendorPayout.status ● VendorPayoutStatus! non-null enum
Status of the vendor payout
VendorPayout.created ● DateTime! non-null scalar
VendorPayout.updated ● DateTime! non-null scalar
VendorPayout.gateway ● String! non-null scalar
VendorPayout.included ● Boolean! non-null scalar
VendorPayout.statusMessage ● String scalar
VendorPayout.adjustmentAmount ● Float! deprecated non-null scalar
This will be removed on August 6, 2025. Use the adjustment field instead.
Adjustment amount.
VendorPayout.average ● Float! deprecated non-null scalar
This will be removed on August 6, 2025.
Average order value.
VendorPayout.commission ● Float! deprecated non-null scalar
This will be removed on August 6, 2025. Use the commissionMoney field instead.
Commission amount.
VendorPayout.currency ● String! deprecated non-null scalar
This will be removed on August 6, 2025.
Currency code.
VendorPayout.discounts ● Float! deprecated non-null scalar
This will be removed on August 6, 2025. Use the discountsMoney field instead.
Discounts amount.
VendorPayout.feeAmount ● Float! deprecated non-null scalar
This will be removed on August 6, 2025. Use the fees field instead.
Fee amount.
VendorPayout.net ● Float! deprecated non-null scalar
This will be removed on August 6, 2025. Use the netSales field instead.
Net sales amount.
VendorPayout.payoutAmount ● Float! deprecated non-null scalar
This will be removed on August 6, 2025. Use the payable field instead.
Payout amount.
VendorPayout.refundAmount ● Float! deprecated non-null scalar
This will be removed on August 6, 2025. Use the refund field instead.
Refund amount.
VendorPayout.shipping ● Float! deprecated non-null scalar
This will be removed on August 6, 2025. Use the shippingMoney field instead.
Shipping amount.
VendorPayout.volumeDiscounts ● Float! deprecated non-null scalar
This will be removed on August 6, 2025.
Volume discounts amount.
VendorPayout.ledgerVersion ● BigInt! non-null scalar
Version number for optimistic locking.
VendorPayout.adjustment ● Money! non-null object
Adjustment amount as Money.
VendorPayout.commissionMoney ● Money! non-null object
Commission amount as Money.
VendorPayout.discountsMoney ● Money! non-null object
Discounts amount as Money.
VendorPayout.fees ● Money! non-null object
Fees amount as Money.
VendorPayout.netSales ● Money! non-null object
Net sales amount as Money.
VendorPayout.payable ● Money! non-null object
Payable amount as Money.
VendorPayout.refund ● Money! non-null object
Refund amount as Money.
VendorPayout.shippingMoney ● Money! non-null object
Shipping amount as Money.
VendorPayout.subtotal ● Money! non-null object
Subtotal amount as Money.
VendorPayout.total ● Money! non-null object
Total amount as Money.
VendorPayout.seller ● Seller! non-null object
The seller for this vendor payout.
VendorPayout.payout ● Payout! non-null object
The parent payout this vendor payout belongs to.
VendorPayout.refundLines ● RefundLineCountableConnection! non-null object
Refund lines included in this vendor payout.
VendorPayout.refundLines.before ● String scalar
Returns the items in the list that come before the specified cursor.
VendorPayout.refundLines.after ● String scalar
Returns the items in the list that come after the specified cursor.
VendorPayout.refundLines.first ● Int scalar
Returns the first n items from the list.
VendorPayout.refundLines.last ● Int scalar
Returns the items in the list that come after the specified cursor.
VendorPayout.events ● [VendorPayoutEvent!]! non-null object
Events/history for this vendor payout.
VendorPayout.events.eventTypes ● [VendorPayoutEventsEnum!] list enum
VendorPayout.orders ● OrderCountableConnection! non-null object
Orders included in this vendor payout.
VendorPayout.orders.before ● String scalar
Returns the items in the list that come before the specified cursor.
VendorPayout.orders.after ● String scalar
Returns the items in the list that come after the specified cursor.
VendorPayout.orders.first ● Int scalar
Returns the first n items from the list.
VendorPayout.orders.last ● Int scalar
Returns the items in the list that come after the specified cursor.
Interfaces
Node interface
An object with a Globally Unique ID
ObjectWithMetadata interface
An object that supports metadata.
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