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!
  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
  externalPayoutSchedule: String
  checklists: [SellerOnboardingChecklist!]!
  documents: [Document!]!
  events(
    before: String
    after: String
    first: Int
    last: Int
  ): SellerEventTypeCountableConnection!
  orders(
    before: String
    after: String
    first: Int
    last: Int
  ): OrderCountableConnection!
  payouts(
    before: String
    after: String
    first: Int
    last: Int
  ): VendorPayoutCountableConnection!
  products(
    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
}
Show more ↓

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.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.externalPayoutSchedule` ● `String` scalar

Payout schedule interval (manual, daily, weekly, monthly)

`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.