MarketplaceConfiguration

Represents a marketplace configuration resource.

type MarketplaceConfiguration {
  tenant: Tenant!
  id: UUID!
  marketplaceName: String!
  requireProductApproval: Boolean!
  payoutAutomationStrategy: MarketplaceConfigurationPayoutAutomationStrategyEnum
  domiciledCurrency: MarketplaceConfigurationCurrencyEnum!
  supportedCurrencies: [String!]!
  defaultCountry: String!
  supportedCountries: [String!]!
  variantUniqueness: VariantUniquenessEnum
  enableMasterProducts: Boolean!
  defaultSellerChecklists: [DefaultSellerChecklist!]!
  enableStockAllocationForDrafts: Boolean!
  validateStockOnOrderPaymentCreation: Boolean!
  timezone: String!
  enableBackorders: Boolean!
  revenueAccrualStrategy: MarketplaceConfigurationRevenueAccrualStrategy!
  availableShippingStrategy: AvailableShippingStrategyEnum
  attributeTemplateStrategy: AttributeTemplateStrategyEnum @deprecated
  fulfillmentModel: FulfillmentModelEnum!
  defaultWeightUnit: WeightUnitsEnum
  defaultLengthUnit: LengthUnitsStrEnum
  automaticFulfillmentDigitalProducts: Boolean!
  defaultDigitalMaxDownloads: Int
  defaultDigitalUrlValidDays: Int
  trackInventoryByDefault: Boolean!
  description: String!
  name: String!
  companyAddress: Address
  defaultMailSenderName: String
  defaultMailSenderAddress: String
  defaultMailSupportAddress: String
  customerSetPasswordUrl: String
  chargeTaxesOnShipping: Boolean!
  trialEndsAt: DateTime
  hasActiveProPlanSubscription: Boolean
}

Show more ↓

Fields

MarketplaceConfiguration.tenant ● Tenant! non-null object

MarketplaceConfiguration.id ● UUID! non-null scalar

MarketplaceConfiguration.marketplaceName ● String! non-null scalar

MarketplaceConfiguration.requireProductApproval ● Boolean! non-null scalar

MarketplaceConfiguration.payoutAutomationStrategy ● MarketplaceConfigurationPayoutAutomationStrategyEnum enum

Determines payout status transformation strategy

MarketplaceConfiguration.domiciledCurrency ● MarketplaceConfigurationCurrencyEnum! non-null enum

Determines domiciled currency

MarketplaceConfiguration.supportedCurrencies ● [String!]! non-null scalar

Supported currencies for the marketplace

MarketplaceConfiguration.defaultCountry ● String! non-null scalar

The default country for the marketplace.

MarketplaceConfiguration.supportedCountries ● [String!]! non-null scalar

Supported countries for the marketplace

MarketplaceConfiguration.variantUniqueness ● VariantUniquenessEnum enum

Determines scope for checking duplicated variant attribute sets

MarketplaceConfiguration.enableMasterProducts ● Boolean! non-null scalar

Whether cross-sell products feature is enabled. When True, sellers can create variants on other sellers' products (if the product allows it).

MarketplaceConfiguration.defaultSellerChecklists ● [DefaultSellerChecklist!]! non-null object

Returns list of default checklists for seller.

MarketplaceConfiguration.enableStockAllocationForDrafts ● Boolean! non-null scalar

MarketplaceConfiguration.validateStockOnOrderPaymentCreation ● Boolean! non-null scalar

MarketplaceConfiguration.timezone ● String! non-null scalar

IANA timezone to display datetime fields in the marketplace

MarketplaceConfiguration.enableBackorders ● Boolean! non-null scalar

MarketplaceConfiguration.revenueAccrualStrategy ● MarketplaceConfigurationRevenueAccrualStrategy! non-null enum

MarketplaceConfiguration.availableShippingStrategy ● AvailableShippingStrategyEnum enum

Determines whether shipping methods are available based on marketplace checkout total or seller totals

MarketplaceConfiguration.attributeTemplateStrategy ● AttributeTemplateStrategyEnum deprecated enum

DEPRECATED

This field will be removed on July 23, 2025.

MarketplaceConfiguration.fulfillmentModel ● FulfillmentModelEnum! non-null enum

Determines the fulfillment model for the marketplace

MarketplaceConfiguration.defaultWeightUnit ● WeightUnitsEnum enum

Default weight unit.

MarketplaceConfiguration.defaultLengthUnit ● LengthUnitsStrEnum enum

Default length unit.

MarketplaceConfiguration.automaticFulfillmentDigitalProducts ● Boolean! non-null scalar

MarketplaceConfiguration.defaultDigitalMaxDownloads ● Int scalar

MarketplaceConfiguration.defaultDigitalUrlValidDays ● Int scalar

MarketplaceConfiguration.trackInventoryByDefault ● Boolean! non-null scalar

MarketplaceConfiguration.description ● String! non-null scalar

MarketplaceConfiguration.name ● String! non-null scalar

MarketplaceConfiguration.companyAddress ● Address object

Company address.

MarketplaceConfiguration.defaultMailSenderName ● String scalar

Default shop's email sender's name.

MarketplaceConfiguration.defaultMailSenderAddress ● String scalar

Default shop's email sender's address.

MarketplaceConfiguration.defaultMailSupportAddress ● String scalar

Default shop's email support's address.

MarketplaceConfiguration.customerSetPasswordUrl ● String scalar

URL of a view where customers can set their password.

MarketplaceConfiguration.chargeTaxesOnShipping ● Boolean! non-null scalar

MarketplaceConfiguration.trialEndsAt ● DateTime scalar

The marketplace's end trial date, or null if the marketplace is not in trial mode.

MarketplaceConfiguration.hasActiveProPlanSubscription ● Boolean scalar

Indicates whether the marketplace is subscribed to an active pro plan.

Returned By

marketplaceConfiguration query

Member Of

MarketplaceConfigurationUpdate object ● Tenant object