Seller
Represents a seller/vendor in the marketplace.
type Seller implements Node, ObjectWithMetadata {
id: ID!
metadata: [MetadataItem!]!
privateMetadata: [MetadataItem!]!
companyName: String!
slug: String!
isMarketplaceSeller: Boolean!
fulfilledByMarketplace: Boolean!
defaultCurrency: String!
createdAt: DateTime!
updatedAt: DateTime!
externalPayoutAccountId: String
externalPayoutOnboardingUrl: String
identification: [String!]
agreementDecisionReason: String!
storeDescription: String!
externalPayoutSchedule: String
pk: Int!
created: DateTime!
updated: DateTime!
status: SellerStatusEnum!
storeDescriptionPlainText: String
canUseInStorefront: Boolean
logo(
size: Int
): Image
banner(
size: Int
): Image
owner: User
defaultShippingAddress: Address
defaultBillingAddress: Address
addresses: [Address!]!
application: SellerApplication
agreement: Agreement
agreementAcknowledged: DateTime
externalPayoutSource: SellerExternalPayoutSource
externalPayoutStatus: Boolean
checklists: [SellerOnboardingChecklist!]!
documents: [Document!]!
events(
before: String
after: String
first: Int
last: Int
): SellerEventTypeCountableConnection!
auditEvents(
before: String
after: String
first: Int
last: Int
): SellerAuditEventCountableConnection!
timeline(
kinds: [TimelineEntryKind!]
): [TimelineEntry!]!
orders(
before: String
after: String
first: Int
last: Int
): OrderCountableConnection!
payouts(
before: String
after: String
first: Int
last: Int
): VendorPayoutCountableConnection!
products(
filter: ProductFilterInput
before: String
after: String
first: Int
last: Int
): ProductCountableConnection!
variants(
before: String
after: String
first: Int
last: Int
): ProductVariantCountableConnection!
warehouses(
before: String
after: String
first: Int
last: Int
): WarehouseCountableConnection!
shippingZones(
before: String
after: String
first: Int
last: Int
): ShippingZoneCountableConnection!
sellerAgreements(
before: String
after: String
first: Int
last: Int
): AgreementSellersCountableConnection!
sellerusers(
before: String
after: String
first: Int
last: Int
): SellerUserTypeCountableConnection!
approvedDate: DateTime
firstProductCreatedDate: DateTime
firstOrderPlacedDate: DateTime
accountSetupTasksAreDone: Boolean
}
Fields
Seller.id ● ID! non-null scalar
The Globally Unique ID of this object
Seller.metadata ● [MetadataItem!]! non-null object
List of public metadata items. Can be accessed without permissions.
Seller.privateMetadata ● [MetadataItem!]! non-null object
List of private metadata items. Requires proper staff permissions to access.
Seller.companyName ● String! non-null scalar
Seller.slug ● String! non-null scalar
Seller.isMarketplaceSeller ● Boolean! non-null scalar
Seller.fulfilledByMarketplace ● Boolean! non-null scalar
Seller.defaultCurrency ● String! non-null scalar
Seller.createdAt ● DateTime! non-null scalar
Seller.updatedAt ● DateTime! non-null scalar
Seller.externalPayoutAccountId ● String scalar
Seller.externalPayoutOnboardingUrl ● String scalar
Seller.identification ● [String!] list scalar
List of seller identification values (e.g., tax IDs)
Seller.agreementDecisionReason ● String! non-null scalar
Reason for agreement decision
Seller.storeDescription ● String! non-null scalar
Store description (HTML)
Seller.externalPayoutSchedule ● String scalar
Payout schedule interval (manual, daily, weekly, monthly)
Seller.pk ● Int! non-null scalar
Primary key of the seller
Seller.created ● DateTime! non-null scalar
Date seller was created
Seller.updated ● DateTime! non-null scalar
Date seller was last updated
Seller.status ● SellerStatusEnum! non-null enum
Current status of the seller
Seller.storeDescriptionPlainText ● String scalar
Store description as plain text
Seller.canUseInStorefront ● Boolean scalar
Whether seller can be used in storefront
Seller.logo ● Image object
Seller's logo image
Seller.logo.size ● Int scalar
Seller.banner ● Image object
Seller's banner image
Seller.banner.size ● Int scalar
Seller.owner ● User object
The owner (user) of this seller
Seller.defaultShippingAddress ● Address object
Seller's default shipping address
Seller.defaultBillingAddress ● Address object
Seller's default billing address
Seller.addresses ● [Address!]! non-null object
List of all seller addresses
Seller.application ● SellerApplication object
Seller application data
Seller.agreement ● Agreement object
Current agreement for the seller
Seller.agreementAcknowledged ● DateTime scalar
Date seller acknowledged their agreement
Seller.externalPayoutSource ● SellerExternalPayoutSource enum
External payout source plugin identifier
Seller.externalPayoutStatus ● Boolean scalar
Whether payouts are enabled for this seller
Seller.checklists ● [SellerOnboardingChecklist!]! non-null object
Seller onboarding checklists
Seller.documents ● [Document!]! non-null object
Documents associated with the seller
Seller.events ● SellerEventTypeCountableConnection! non-null object
Seller events.
Seller.events.before ● String scalar
Returns the items in the list that come before the specified cursor.
Seller.events.after ● String scalar
Returns the items in the list that come after the specified cursor.
Seller.events.first ● Int scalar
Returns the first n items from the list.
Seller.events.last ● Int scalar
Returns the items in the list that come after the specified cursor.
Seller.auditEvents ● SellerAuditEventCountableConnection! non-null object
Database-level audit trail for this seller. Captures every field change via PostgreSQL triggers, including status transitions, payout config changes, and profile updates.
Seller.auditEvents.before ● String scalar
Returns the items in the list that come before the specified cursor.
Seller.auditEvents.after ● String scalar
Returns the items in the list that come after the specified cursor.
Seller.auditEvents.first ● Int scalar
Returns the first n items from the list.
Seller.auditEvents.last ● Int scalar
Returns the items in the list that come after the specified cursor.
Seller.timeline ● [TimelineEntry!]! non-null object
Unified change-history feed for this seller. Projects pghistory SellerAuditEvent rows (status transitions, profile edits, payout-config changes) into a TimelineEntry list ordered most-recent-first. Powers the dashboard Events tab and mirrors the Agreement and Order timeline pattern. Optional kinds argument filters server-side.
Seller.timeline.kinds ● [TimelineEntryKind!] list enum
Seller.orders ● OrderCountableConnection! non-null object
Orders for this seller
Seller.orders.before ● String scalar
Returns the items in the list that come before the specified cursor.
Seller.orders.after ● String scalar
Returns the items in the list that come after the specified cursor.
Seller.orders.first ● Int scalar
Returns the first n items from the list.
Seller.orders.last ● Int scalar
Returns the items in the list that come after the specified cursor.
Seller.payouts ● VendorPayoutCountableConnection! non-null object
Payouts for this seller
Seller.payouts.before ● String scalar
Returns the items in the list that come before the specified cursor.
Seller.payouts.after ● String scalar
Returns the items in the list that come after the specified cursor.
Seller.payouts.first ● Int scalar
Returns the first n items from the list.
Seller.payouts.last ● Int scalar
Returns the items in the list that come after the specified cursor.
Seller.products ● ProductCountableConnection! non-null object
Products for this seller
Seller.products.filter ● ProductFilterInput input
Seller.products.before ● String scalar
Returns the items in the list that come before the specified cursor.
Seller.products.after ● String scalar
Returns the items in the list that come after the specified cursor.
Seller.products.first ● Int scalar
Returns the first n items from the list.
Seller.products.last ● Int scalar
Returns the items in the list that come after the specified cursor.
Seller.variants ● ProductVariantCountableConnection! non-null object
Product variants for this seller
Seller.variants.before ● String scalar
Returns the items in the list that come before the specified cursor.
Seller.variants.after ● String scalar
Returns the items in the list that come after the specified cursor.
Seller.variants.first ● Int scalar
Returns the first n items from the list.
Seller.variants.last ● Int scalar
Returns the items in the list that come after the specified cursor.
Seller.warehouses ● WarehouseCountableConnection! non-null object
Warehouses for this seller
Seller.warehouses.before ● String scalar
Returns the items in the list that come before the specified cursor.
Seller.warehouses.after ● String scalar
Returns the items in the list that come after the specified cursor.
Seller.warehouses.first ● Int scalar
Returns the first n items from the list.
Seller.warehouses.last ● Int scalar
Returns the items in the list that come after the specified cursor.
Seller.shippingZones ● ShippingZoneCountableConnection! non-null object
Shipping zones for this seller
Seller.shippingZones.before ● String scalar
Returns the items in the list that come before the specified cursor.
Seller.shippingZones.after ● String scalar
Returns the items in the list that come after the specified cursor.
Seller.shippingZones.first ● Int scalar
Returns the first n items from the list.
Seller.shippingZones.last ● Int scalar
Returns the items in the list that come after the specified cursor.
Seller.sellerAgreements ● AgreementSellersCountableConnection! non-null object
Seller agreements history
Seller.sellerAgreements.before ● String scalar
Returns the items in the list that come before the specified cursor.
Seller.sellerAgreements.after ● String scalar
Returns the items in the list that come after the specified cursor.
Seller.sellerAgreements.first ● Int scalar
Returns the first n items from the list.
Seller.sellerAgreements.last ● Int scalar
Returns the items in the list that come after the specified cursor.
Seller.sellerusers ● SellerUserTypeCountableConnection! non-null object
Users associated with this seller
Seller.sellerusers.before ● String scalar
Returns the items in the list that come before the specified cursor.
Seller.sellerusers.after ● String scalar
Returns the items in the list that come after the specified cursor.
Seller.sellerusers.first ● Int scalar
Returns the first n items from the list.
Seller.sellerusers.last ● Int scalar
Returns the items in the list that come after the specified cursor.
Seller.approvedDate ● DateTime scalar
Date seller was most recently approved
Seller.firstProductCreatedDate ● DateTime scalar
Date first product was created
Seller.firstOrderPlacedDate ● DateTime scalar
Date first order was placed
Seller.accountSetupTasksAreDone ● Boolean scalar
Whether all required onboarding tasks are complete
Interfaces
Node interface
An object with a Globally Unique ID
ObjectWithMetadata interface
An object that supports metadata.
Returned By
seller query
Member Of
AgreementSellers object ● App object ● Attribute object ● AttributeValue object ● CheckoutLine object ● CheckoutSellerShipping object ● DashboardSellerOrderPerformanceType object ● Fulfillment object ● Ledger object ● MenuItem object ● Order object ● Plugin object ● Policy object ● Product object ● ProductType object ● ProductVariant object ● SellerAddressCreate object ● SellerAddressDelete object ● SellerAddressSetDefault object ● SellerAddressUpdate object ● SellerApplication object ● SellerApplicationUpdate object ● SellerBannerDelete object ● SellerBannerUpdate object ● SellerCountableEdge object ● SellerDataCreate object ● SellerDataUpdate object ● SellerEventType object ● SellerLogoDelete object ● SellerLogoUpdate object ● SellerOnboardingChecklist object ● SellerOwnerDelete object ● SellerSettingsUpdate object ● SellerShellCreate object ● SellerUserType object ● SellerWithOwnerCreate object ● ShippingZone object ● ShopifyWebhookTransaction object ● User object ● VendorPayout object ● Warehouse object ● WebhookJob object
Implemented By
DocumentTargetInstance union ● Vendor union