Skip to main content

Returns the Shop associated with the storefront access token. The Shop object provides general store information such as the shop name, description, and primary domain.

Use this query to access data like store policies, PaymentSettings, Brand configuration, and shipping destinations. It also exposes ShopPayInstallmentsPricing and SocialLoginProvider options for customer accounts.

•Shop!

The central hub for store-wide settings and information accessible through the Storefront API. Provides the shop's name, description, and branding configuration including logos and colors through the Brand object.

Access store policies such as privacy, refund, shipping, and terms of service via ShopPolicy, and the subscription policy via ShopPolicyWithDefault. PaymentSettings expose accepted card brands, supported digital wallets, and enabled presentment currencies. The object also includes the primary Domain, countries the shop ships to, ShopPayInstallmentsPricing, and SocialLoginProvider options for customer accounts.

•Brand

The shop's branding configuration.

•ShopPolicy

The shop's contact information.

Arguments

•Boolean
Default:false

Sanitize the policy content.


Anchor to customerAccountTranslationscustomerAccountTranslations
•[Translation!]

Translations for customer accounts.

•String

The URL for the customer account (only present if shop has a customer account vanity domain).

•String

A description of the shop.

•ID!
non-null

A globally-unique ID.

•ShopPolicy

The shop's legal notice.

Arguments

•Boolean
Default:false

Sanitize the policy content.


Anchor to marketingConsentPreselectedmarketingConsentPreselected
•Boolean!
non-null

Whether the marketing consent checkbox should be pre-checked based on the shop's email marketing settings and the buyer's country.

Anchor to marketingConsentSigninEnabledmarketingConsentSigninEnabled
•Boolean!
non-null

Whether the marketing consent checkbox should be shown on the customer sign-in web component.

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Arguments

•String

The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

•String!
required

The identifier for the metafield.


•[Metafield]!
non-null

A list of custom fields that a merchant associates with a Shopify resource.

Arguments

•[HasMetafieldsIdentifier!]!
required

The list of metafields to retrieve by namespace and key.

The input must not contain more than 250 values.


•String!
non-null

A string representing the way currency is formatted when the currency isn’t specified.

•String!
non-null

The shop’s name.

•PaymentSettings!
non-null

Settings related to payments.

•Domain!
non-null

The primary domain of the shop’s Online Store.

•ShopPolicy

The shop’s privacy policy.

Arguments

•Boolean
Default:false

Sanitize the policy content.


•ShopPolicy

The shop’s refund policy.

Arguments

•Boolean
Default:false

Sanitize the policy content.


•ShopPolicy

The shop’s shipping policy.

Arguments

•Boolean
Default:false

Sanitize the policy content.


•[CountryCode!]!
non-null

Countries that the shop ships to.

Anchor to shopPayInstallmentsPricingshopPayInstallmentsPricing
•ShopPayInstallmentsPricing

The Shop Pay Installments pricing information for the shop.

Anchor to socialLoginProviderssocialLoginProviders
•[SocialLoginProvider!]!
non-null

The social login providers for customer accounts.

•ShopPolicyWithDefault

The shop’s subscription policy.

Arguments

•Boolean
Default:false

Sanitize the policy content.


•ShopPolicy

The shop's terms of sale.

Arguments

•Boolean
Default:false

Sanitize the policy content.


•ShopPolicy

The shop’s terms of service.

Arguments

•Boolean
Default:false

Sanitize the policy content.



Was this section helpful?