Skip to main content

Seller

No description

type Seller implements Node, ObjectWithMetadata {
id: ID!
companyName: String!
slug: String!
logo(
size: Int
): Image
status: SellerStatus!
banner(
size: Int
): Image
products(
offset: Int
before: String
after: String
first: Int
last: Int
): ProductCountableConnection!
variants(
offset: Int
before: String
after: String
first: Int
last: Int
): ProductVariantCountableConnection!
externalPayoutAccountId: String
externalPayoutSource: SellerExternalPayoutSource
externalPayoutOnboardingUrl: String
isMarketplaceSeller: Boolean!
identification: [String!]
addresses: [Address!]
defaultShippingAddress: Address
defaultBillingAddress: Address
owner: User
defaultCurrency: String!
fulfilledByMarketplace: Boolean!
sellerusers(
offset: Int
before: String
after: String
first: Int
last: Int
): SellerUserTypeCountableConnection!
events(
offset: Int
before: String
after: String
first: Int
last: Int
): SellerEventTypeCountableConnection!
checklists: [SellerOnboardingChecklist!]
application: SellerApplication
payouts(
offset: Int
before: String
after: String
first: Int
last: Int
): VendorPayoutCountableConnection!
shippingZones(
offset: Int
before: String
after: String
first: Int
last: Int
): ShippingZoneCountableConnection!
orders(
offset: Int
before: String
after: String
first: Int
last: Int
): OrderCountableConnection!
sellerAgreements(
offset: Int
before: String
after: String
first: Int
last: Int
): AgreementSellersCountableConnection!
warehouses(
offset: Int
before: String
after: String
first: Int
last: Int
): WarehouseCountableConnection!
privateMetadata: [MetadataItem!]!
metadata: [MetadataItem!]!
agreement: Agreement
agreementAcknowledged: DateTime
canUseInStorefront: Boolean
pk: Int
externalPayoutStatus: Boolean
externalPayoutSchedule: String
agreementDecisionReason: String
storeDescription: String
storeDescriptionPlainText: String
documents: [Document!]
approvedDate: DateTime
firstProductCreatedDate: DateTime
firstOrderPlacedDate: DateTime
created: DateTime!
updated: DateTime!
accountSetupTasksAreDone: Boolean
}
Show more ↓

Fields

Seller.id ● ID! non-null scalar

The ID of the object

Seller.companyName ● String! non-null scalar

Seller.slug ● String! non-null scalar

Seller.logo ● Image object

Seller.logo.size ● Int scalar

Size of the avatar.

Seller.status ● SellerStatus! non-null enum

Seller.banner ● Image object

Seller.banner.size ● Int scalar

Size of the banner.

Seller.products ● ProductCountableConnection! non-null object

Seller.products.offset ● Int scalar
Seller.products.before ● String scalar
Seller.products.after ● String scalar
Seller.products.first ● Int scalar
Seller.products.last ● Int scalar

Seller.variants ● ProductVariantCountableConnection! non-null object

Seller.variants.offset ● Int scalar
Seller.variants.before ● String scalar
Seller.variants.after ● String scalar
Seller.variants.first ● Int scalar
Seller.variants.last ● Int scalar

Seller.externalPayoutAccountId ● String scalar

Seller.externalPayoutSource ● SellerExternalPayoutSource enum

Seller.externalPayoutOnboardingUrl ● String scalar

Seller.isMarketplaceSeller ● Boolean! non-null scalar

Seller.identification ● [String!] list scalar

Seller.addresses ● [Address!] list object

List of all addresses for this seller.

Seller.defaultShippingAddress ● Address object

Seller.defaultBillingAddress ● Address object

Seller.owner ● User object

Owner (user) of the seller.

Seller.defaultCurrency ● String! non-null scalar

Seller.fulfilledByMarketplace ● Boolean! non-null scalar

Seller.sellerusers ● SellerUserTypeCountableConnection! non-null object

Seller.sellerusers.offset ● Int scalar
Seller.sellerusers.before ● String scalar
Seller.sellerusers.after ● String scalar
Seller.sellerusers.first ● Int scalar
Seller.sellerusers.last ● Int scalar

Seller.events ● SellerEventTypeCountableConnection! non-null object

Seller.events.offset ● Int scalar
Seller.events.before ● String scalar
Seller.events.after ● String scalar
Seller.events.first ● Int scalar
Seller.events.last ● Int scalar

Seller.checklists ● [SellerOnboardingChecklist!] list object

Seller checklist to complete. Can be empty in case when this user do not have access to see checklist

Seller.application ● SellerApplication object

Application for the seller.

Seller.payouts ● VendorPayoutCountableConnection! non-null object

Seller.payouts.offset ● Int scalar
Seller.payouts.before ● String scalar
Seller.payouts.after ● String scalar
Seller.payouts.first ● Int scalar
Seller.payouts.last ● Int scalar

Seller.shippingZones ● ShippingZoneCountableConnection! non-null object

Seller.shippingZones.offset ● Int scalar
Seller.shippingZones.before ● String scalar
Seller.shippingZones.after ● String scalar
Seller.shippingZones.first ● Int scalar
Seller.shippingZones.last ● Int scalar

Seller.orders ● OrderCountableConnection! non-null object

Seller.orders.offset ● Int scalar
Seller.orders.before ● String scalar
Seller.orders.after ● String scalar
Seller.orders.first ● Int scalar
Seller.orders.last ● Int scalar

Seller.sellerAgreements ● AgreementSellersCountableConnection! non-null object

Seller.sellerAgreements.offset ● Int scalar
Seller.sellerAgreements.before ● String scalar
Seller.sellerAgreements.after ● String scalar
Seller.sellerAgreements.first ● Int scalar
Seller.sellerAgreements.last ● Int scalar

Seller.warehouses ● WarehouseCountableConnection! non-null object

Seller.warehouses.offset ● Int scalar
Seller.warehouses.before ● String scalar
Seller.warehouses.after ● String scalar
Seller.warehouses.first ● Int scalar
Seller.warehouses.last ● Int scalar

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

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

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

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

Seller.agreement ● Agreement object

Agreement for the seller.

Seller.agreementAcknowledged ● DateTime scalar

Date seller acknowledged their existing agreement.

Seller.canUseInStorefront ● Boolean scalar

Seller.pk ● Int scalar

Seller.externalPayoutStatus ● Boolean scalar

Seller.externalPayoutSchedule ● String scalar

Seller.agreementDecisionReason ● String scalar

Seller.storeDescription ● String scalar

Seller.storeDescriptionPlainText ● String scalar

Seller.documents ● [Document!] list object

List of documents associated with the seller.

Seller.approvedDate ● DateTime scalar

Date on which this seller was most recently approved if they have been at all, null if their status is anything else

Seller.firstProductCreatedDate ● DateTime scalar

Date on which the first product of this seller was created, null if no product has been created

Seller.firstOrderPlacedDate ● DateTime scalar

Date on which the first order for this seller was made, null if no order has been created

Seller.created ● DateTime! non-null scalar

Seller.updated ● DateTime! non-null scalar

Seller.accountSetupTasksAreDone ● Boolean scalar

Interfaces

Node interface

An object with an ID

ObjectWithMetadata interface

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 ● 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

Was this page helpful?