Shop

Represents a shop resource containing general shop data and configuration.

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

Show more ↓

Fields

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

List of available payment gateways.

Shop.availablePaymentGateways.currency ● String scalar

A currency for which gateways will be returned.

Shop.geolocalization ● Geolocalization object

Customer's geolocalization data.

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

List of countries available in the shop.

Shop.countries.languageCode ● LanguageCodeEnum enum

A language code to return the translation for.

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

List of supported currencies.

Shop.defaultCountry ● CountryDisplay object

Shop's default country.

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.description ● String scalar

Shop's description.

Shop.domain ● Domain! non-null object

Shop's domain data.

Shop.apiUrl ● String scalar

API url for the shop.

Shop.dashboardUrl ● String scalar

Dashboard url for the shop.

Shop.name ● String! non-null scalar

Shop's name.

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

List of available permissions.

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

List of possible phone prefixes.

Shop.chargeTaxesOnShipping ● Boolean! non-null scalar

Charge taxes on shipping.

Shop.trackInventoryByDefault ● Boolean scalar

Enable inventory tracking.

Shop.defaultWeightUnit ● WeightUnitsEnum enum

Default weight unit.

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.companyAddress ● Address object

Company address.

Shop.customerSetPasswordUrl ● String scalar

URL of a view where customers can set their password.

Shop.loginForCheckout ● Boolean scalar

Is authenticated user required for checkout.

Shop.loginForPrice ● Boolean scalar

Is authenticated user required for to view product price information.

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

Contexts that integrations should be filtered to. If not specified, all contexts will be returned.

Shop.requireProductApproval ● Boolean scalar

Determines whether seller products require approval

Shop.timezone ● String! non-null scalar

The IANA timezone to use when displaying all dates and times

Shop.checkoutTheme ● CheckoutTheme object

The shop's active checkout theme.

Shop.storefrontTheme ● StorefrontTheme object

The shop's active storefront theme.

Shop.sellerOnboardingSettings ● SellerOnboardingSettings object

The seller onboarding settings for the shop.

Returned By

shop query

Member Of

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