MarketplaceConfiguration

Represents a marketplace configuration resource.

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

Show more ↓

Fields

MarketplaceConfiguration.id ● ID! non-null scalar

The ID of the object

MarketplaceConfiguration.marketplaceName ● String! non-null scalar

MarketplaceConfiguration.requireProductApproval ● Boolean! non-null scalar

MarketplaceConfiguration.enableMasterProducts ● Boolean! non-null scalar

Enable cross-sell products feature. When enabled, sellers can create variants on other sellers' products (if the product allows it). Requires variant_uniqueness=UNIQUE_PER_SELLER.

MarketplaceConfiguration.enableStockAllocationForDrafts ● Boolean! non-null scalar

MarketplaceConfiguration.validateStockOnOrderPaymentCreation ● Boolean! non-null scalar

MarketplaceConfiguration.enableBackorders ● Boolean! non-null scalar

MarketplaceConfiguration.automaticFulfillmentDigitalProducts ● Boolean! non-null scalar

MarketplaceConfiguration.defaultDigitalMaxDownloads ● Int scalar

MarketplaceConfiguration.defaultDigitalUrlValidDays ● Int scalar

MarketplaceConfiguration.trackInventoryByDefault ● Boolean! non-null scalar

MarketplaceConfiguration.name ● String! non-null scalar

MarketplaceConfiguration.defaultMailSenderName ● String! non-null scalar

MarketplaceConfiguration.defaultMailSenderAddress ● String scalar

MarketplaceConfiguration.defaultMailSupportAddress ● String scalar

MarketplaceConfiguration.customerSetPasswordUrl ● String scalar

MarketplaceConfiguration.chargeTaxesOnShipping ● Boolean! non-null scalar

MarketplaceConfiguration.description ● String! non-null scalar

Shop's description.

MarketplaceConfiguration.payoutAutomationStrategy ● MarketplaceConfigurationPayoutAutomationStrategyEnum! non-null enum

Determines payout status transformation strategy.

MarketplaceConfiguration.domiciledCurrency ● MarketplaceConfigurationCurrencyEnum! non-null enum

Determines domiciled currency.

MarketplaceConfiguration.variantUniqueness ● VariantUniquenessEnum! non-null enum

Determines scope for checking duplicated variant attribute sets.

MarketplaceConfiguration.fulfillmentModel ● FulfillmentModelEnum! non-null enum

Determines the fulfillment model for the marketplace.

MarketplaceConfiguration.defaultWeightUnit ● WeightUnitsEnum! non-null enum

Default weight unit.

MarketplaceConfiguration.defaultLengthUnit ● LengthUnitsStrEnum! non-null enum

Default length unit.

MarketplaceConfiguration.availableShippingStrategy ● AvailableShippingStrategyEnum! non-null enum

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

MarketplaceConfiguration.revenueAccrualStrategy ● MarketplaceConfigurationRevenueAccrualStrategy! non-null enum

Determines revenue accrual strategy.

MarketplaceConfiguration.attributeTemplateStrategy ● AttributeTemplateStrategyEnum! deprecated non-null enum

DEPRECATED

This field will be removed on July 23, 2025.

Determines attribute template strategy.

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

Supported currencies for the marketplace.

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

Supported countries for the marketplace.

MarketplaceConfiguration.defaultCountry ● String! non-null scalar

The default country for the marketplace.

MarketplaceConfiguration.companyAddress ● Address object

Company address.

MarketplaceConfiguration.timezone ● String! non-null scalar

IANA timezone to display datetime fields in the marketplace.

MarketplaceConfiguration.tenant ● Tenant object

The tenant that owns this marketplace configuration.

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

Returns list of default checklists for seller.

MarketplaceConfiguration.trialEndsAt ● DateTime scalar

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

MarketplaceConfiguration.hasActiveProPlanSubscription ● Boolean! non-null scalar

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

Returned By

marketplaceConfiguration query

Member Of

MarketplaceConfigurationUpdate object ● Tenant object