Skip to Content

StoreInfo

Basic information about the store including domain, logo, policies, and account settings.

Type Definition

type StoreInfo { domain: String! logo: String favicon: String name: String! customerAccountsEnabled: Boolean! customerAccountsOptional: Boolean! customerAccountsRequireApproval: Boolean! catalogBrowsingRequiresAccount: Boolean! canSellOverStock: Boolean! isPasswordProtected: Boolean! defaultConsentOptions: [String]! }

Fields

FieldTypeNullabilityDescriptionRelated Types
domainStringNon-nullThe domain of the store.String
logoStringNullableThe store’s logo if it’s set.String
faviconStringNullableThe store’s favicon if it’s set.String
nameStringNon-nullThe name of the store.String
customerAccountsEnabledBooleanNon-nullReturns true if customer accounts are enabled in the store.Boolean
customerAccountsOptionalBooleanNon-nullReturns true if customer accounts are optional.Boolean
customerAccountsRequireApprovalBooleanNon-nullReturns true if customer accounts need to be approved.Boolean
catalogBrowsingRequiresAccountBooleanNon-nullReturns true if a customer account is required to browse the catalog.Boolean
canSellOverStockBooleanNon-nullReturns true if the store can sell over stock.Boolean
isPasswordProtectedBooleanNon-nullReturns true if the store has password protection.Boolean
defaultConsentOptions[String]Non-nullReturns the default consent options for the store that a user can accept.[String]

Relationships

The StoreInfo type primarily contains scalar fields representing store metadata and settings. It does not directly reference other complex object types but includes arrays of strings (defaultConsentOptions) to represent configurable options.

Usage Examples

Basic Query

query { store { domain name customerAccountsEnabled } }

Field Selection

query { store { domain logo favicon name customerAccountsEnabled customerAccountsOptional customerAccountsRequireApproval catalogBrowsingRequiresAccount canSellOverStock isPasswordProtected defaultConsentOptions } }

Nested Queries

The StoreInfo type does not contain nested object fields; all fields are scalar or lists of scalars.

Filtering and Sorting

Filtering, sorting, and pagination do not apply directly to the StoreInfo type, as it represents a singleton object describing the store.

Implements

StoreInfo does not implement any interfaces.

Connections

There are no connection fields on StoreInfo.

  • String
  • Boolean
  • [String]

Best Practices

  • Always query only the fields you need to optimize response size and performance.
  • Use the defaultConsentOptions field to dynamically render consent checkboxes or options in your frontend applications.
  • Check customerAccountsEnabled before rendering customer account-related UI elements.
  • Use isPasswordProtected to conditionally display password entry prompts or restrict access.
  • Since StoreInfo is a singleton object, avoid using pagination or filtering queries on this type.

Notes

  • The defaultConsentOptions field returns an array of strings representing the consent choices available to users; these are typically used for compliance with privacy regulations.
  • All boolean fields reflect current store settings and can be used to tailor user experience dynamically.
  • The API currently requires no authentication to query StoreInfo, but this may change in future versions.
  • Because StoreInfo contains static configuration data, it is recommended to cache responses where appropriate to reduce load and improve performance.
  • No computed or derived fields are present; all fields represent stored configuration values.
Last updated on