Skip to main content

Tenant

Represents a tenant in the multi-tenant system.

type Tenant implements Node {
id: ID!
name: String!
slug: String!
isActive: Boolean!
createdAt: DateTime!
trialEndsAt: DateTime
onboardingStepsCompleted: [String!]!
storefrontUrl: String!
marketplaceConfiguration: MarketplaceConfiguration
}

Fields

Tenant.id ● ID! non-null scalar

The Globally Unique ID of this object

Tenant.name ● String! non-null scalar

Tenant name (unique identifier)

Tenant.slug ● String! non-null scalar

URL-friendly tenant identifier

Tenant.isActive ● Boolean! non-null scalar

Whether tenant is active

Tenant.createdAt ● DateTime! non-null scalar

Tenant.trialEndsAt ● DateTime scalar

Tenant.onboardingStepsCompleted ● [String!]! non-null scalar

List of completed onboarding steps

Tenant.storefrontUrl ● String! non-null scalar

URL of the storefront

Tenant.marketplaceConfiguration ● MarketplaceConfiguration object

Marketplace configuration for the tenant

Interfaces

Node interface

An object with a Globally Unique ID

Returned By

currentTenant query ● tenant query

Member Of

Agreement object ● AgreementCommission object ● AgreementFees object ● AgreementSellers object ● AttributeValue object ● CheckoutEvent object ● CheckoutSellerShipping object ● DesignerDataType object ● Document object ● EmailEvent object ● MarketplaceConfiguration object ● Media object ● OrderFee object ● Payout object ● Plugin object ● SellerOnboardingChecklist object ● SellerUserType object ● ShopifyWebhookTransaction object ● TenantCountableEdge object ● TenantOnboardingUpdate object ● TenantUpdate object ● WebhookEventLog object ● WebhookJob object

Was this page helpful?