Settings

OBJECT

Definition

1 type Settings {
2   storeName: String!
3   storeHash: String!
4   storeCountryCode: String!
5   status: StorefrontStatusType!
6   logo: LogoField!
7   logoV2: StoreLogo!
8   contact: ContactField
9   url: UrlField!
10   display: DisplayField!
11   channelId: Long!
12   tax: TaxDisplaySettings
13   search: Search!
14   storefront: Storefront!
15   isGoogleAiPredictionEnabled: Boolean!
16   inventory: InventorySettings
17   reCaptcha: ReCaptchaSettings!
18   socialMediaLinks: [SocialMediaLink!]!
19   checkout: CheckoutSettings
20   statusMessage: String
21   customers: CustomersSettings
22   locales: [Locale!]!
23   faviconUrl: String
24   webAnalytics: WebAnalytics
25   currency: CurrencySettings!
26   formFields: FormFields!
27   seo: SeoDetails
28   robotsTxt: String
29   security: SecuritySettings
30   privacy: PrivacySettings
31   inactivity: InactivitySettings
32   shipping: Shipping
33   giftCertificates(currencyCode: currencyCode): GiftCertificateSettings
34   reviews: ReviewsSettings!
35   newsletter: NewsletterSettings!
36 }

Store settings information from the control panel.

Fields

storeNameStringRequired

The name of the store.

storeHashStringRequired

The hash of the store.

storeCountryCodeStringRequired

The ISO 3166-1 alpha-2 country code of the store.

statusStorefrontStatusTypeRequired

The current store status.

Allowed values:

logoV2StoreLogoRequired

Logo information for the store.

urlUrlFieldRequired

Store urls.

displayDisplayFieldRequired

Store display format information.

channelIdLongRequired

Channel ID.

searchSearchRequired

Store search settings.

storefrontStorefrontRequired

Storefront settings.

isGoogleAiPredictionEnabledBooleanRequired

Flag indicating whether the Google AI (product recommendation is enabled).

reCaptchaReCaptchaSettingsRequired

ReCaptcha settings.

socialMediaLinkslist of SocialMediaLinksRequired

The social media links of connected platforms to the storefront.

localeslist of LocalesRequired

Store locales.

currencyCurrencySettingsRequired

Currency settings.

formFieldsFormFieldsRequired

The form fields to display on the storefront during customer registration or address creation.

reviewsReviewsSettingsRequired

Product review settings.

logoLogoFieldRequiredDeprecated

Logo information for the store.

Deprecated: Use logoV2 instead.

contactContactFieldOptional

Contact information for the store.

taxTaxDisplaySettingsOptional

The tax display settings object

inventoryInventorySettingsOptional

Inventory settings.

checkoutCheckoutSettingsOptional

Checkout settings.

statusMessageStringOptional

The customer-facing message associated with the current storefront status.

customersCustomersSettingsOptional

Customers settings.

faviconUrlStringOptional

Store favicon url.

webAnalyticsWebAnalyticsOptional

Analytics settings.

seoSeoDetailsOptional

Store seo information.

robotsTxtStringOptional

The robots.txt file content for the store.

securitySecuritySettingsOptional

Security settings from control panel

privacyPrivacySettingsOptional

Privacy settings from control panel

inactivityInactivitySettingsOptional

Inactivity settings from control panel

shippingShippingOptional

Store shipping settings.

giftCertificatesGiftCertificateSettingsOptional

The settings for gift certificates.

Referenced by

Fields

Site.settings