Shop

Represents a shop resource containing general shop data and configuration.

type Shop {
  name: String!
  description: String
  timezone: String!
  chargeTaxesOnShipping: Boolean!
  trackInventoryByDefault: Boolean
  loginForCheckout: Boolean
  loginForPrice: Boolean
  requireProductApproval: Boolean
  domain: Domain!
  defaultCountry: CountryDisplay
  defaultWeightUnit: WeightUnitsEnum
  supportedCurrencies: [NauticalCurrency!]!
  phonePrefixes: [String!]!
  apiUrl: String
  dashboardUrl: String
  customerSetPasswordUrl: String
  checkoutTheme: CheckoutTheme
  storefrontTheme: StorefrontTheme
  sellerOnboardingSettings: SellerOnboardingSettings
  geolocalization: Geolocalization
  companyAddress: Address
  defaultMailSenderName: String
  defaultMailSenderAddress: String
  defaultMailSupportAddress: String
  automaticFulfillmentDigitalProducts: Boolean
  defaultDigitalMaxDownloads: Int
  defaultDigitalUrlValidDays: Int
  availablePaymentGateways(
    currency: String
  ): [PaymentGateway!]!
  countries(
    languageCode: LanguageCodeEnum
  ): [CountryDisplay!]!
  permissions: [Permission!]!
  activePlugins: [Plugin!]!
  storefrontUiIntegrations(
    contexts: [AppStorefrontIntegrationContextEnum!]
  ): [AppStorefrontIntegration!]!
}

Show more ↓

Fields

Shop.name ● String! non-null scalar

Shop.description ● String scalar

Shop.timezone ● String! non-null scalar

Shop.chargeTaxesOnShipping ● Boolean! non-null scalar

Shop.trackInventoryByDefault ● Boolean scalar

Shop.loginForCheckout ● Boolean scalar

Shop.loginForPrice ● Boolean scalar

Shop.requireProductApproval ● Boolean scalar

Shop.domain ● Domain! non-null object

Shop.defaultCountry ● CountryDisplay object

Shop.defaultWeightUnit ● WeightUnitsEnum enum

Shop.supportedCurrencies ● [NauticalCurrency!]! non-null object

List of supported currencies.

Shop.phonePrefixes ● [String!]! non-null scalar

List of country phone prefixes.

Shop.apiUrl ● String scalar

Shop.dashboardUrl ● String scalar

Shop.customerSetPasswordUrl ● String scalar

Shop.checkoutTheme ● CheckoutTheme object

Shop.storefrontTheme ● StorefrontTheme object

Shop.sellerOnboardingSettings ● SellerOnboardingSettings object

Shop.geolocalization ● Geolocalization object

Shop.companyAddress ● Address object

Company address.

Shop.defaultMailSenderName ● String scalar

Default shop's email sender's name.

Shop.defaultMailSenderAddress ● String scalar

Default shop's email sender's address.

Shop.defaultMailSupportAddress ● String scalar

Default shop's email support's address.

Shop.automaticFulfillmentDigitalProducts ● Boolean scalar

Enable automatic fulfillment for all digital products.

Shop.defaultDigitalMaxDownloads ● Int scalar

Default number of max downloads per digital content URL.

Shop.defaultDigitalUrlValidDays ● Int scalar

Default number of days which digital content URL will be valid.

Shop.availablePaymentGateways ● [PaymentGateway!]! non-null object

List of available payment gateways.

Shop.availablePaymentGateways.currency ● String scalar

Shop.countries ● [CountryDisplay!]! non-null object

List of countries available in the shop.

Shop.countries.languageCode ● LanguageCodeEnum enum

Shop.permissions ● [Permission!]! non-null object

List of available permissions.

Shop.activePlugins ● [Plugin!]! non-null object

Gets active plugins.

Shop.storefrontUiIntegrations ● [AppStorefrontIntegration!]! non-null object

Storefront integrations for the given contexts.

Shop.storefrontUiIntegrations.contexts ● [AppStorefrontIntegrationContextEnum!] list enum

Returned By

shop query

Member Of

CheckoutThemeCreate object ● CheckoutThemeUpdate object ● SellerOnboardingSettingsCreate object ● SellerOnboardingSettingsUpdate object ● ShopFetchTaxRates object ● StorefrontThemeCreate object ● StorefrontThemeUpdate object