Shop
Requires access scope.
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 ,
and the subscription policy via .
expose accepted card brands, supported digital wallets, and enabled presentment
currencies. The object also includes the primary
Domain,
countries the shop ships to, , and
options for customer accounts.
Anchor to FieldsFields
- brand (Brand)
- contactInformation (ShopPolicy)
- customerAccountTranslations ([Translation!])
- customerAccountUrl (String)
- description (String)
- id (ID!)
- legalNotice (ShopPolicy)
- marketingConsentPreselected (Boolean!)
- marketingConsentSigninEnabled (Boolean!)
- metafield (Metafield)
- metafields ([Metafield]!)
- moneyFormat (String!)
- name (String!)
- paymentSettings (PaymentSettings!)
- primaryDomain (Domain!)
- privacyPolicy (ShopPolicy)
- refundPolicy (ShopPolicy)
- shippingPolicy (ShopPolicy)
- shipsToCountries ([CountryCode!]!)
- shopPayInstallmentsPricing (ShopPayInstallmentsPricing)
- socialLoginProviders ([SocialLoginProvider!]!)
- subscriptionPolicy (ShopPolicyWithDefault)
- termsOfSale (ShopPolicy)
- termsOfService (ShopPolicy)
- Anchor to brandbrand•Brand
The shop's branding configuration.
Show fields
- Anchor to contactInformationcontact•Shop
Information Policy The shop's contact information.
Show fields
- Anchor to sanitizedsanitized•BooleanDefault:false
Sanitize the policy content.
Arguments
- Anchor to customerAccountTranslationscustomer•[Translation!]
Account Translations Translations for customer accounts.
Show fields
- Anchor to customerAccountUrlcustomer•String
Account Url The URL for the customer account (only present if shop has a customer account vanity domain).
- Anchor to descriptiondescription•String
A description of the shop.
- •ID!non-null
A globally-unique ID.
- Anchor to legalNoticelegal•Shop
Notice Policy The shop's legal notice.
Show fields
- Anchor to sanitizedsanitized•BooleanDefault:false
Sanitize the policy content.
Arguments
- Anchor to marketingConsentPreselectedmarketing•Boolean!
Consent Preselected 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 marketingConsentSigninEnabledmarketing•Boolean!
Consent Signin Enabled non-null Whether the marketing consent checkbox should be shown on the customer sign-in web component.
- Anchor to metafieldmetafield•MetafieldToken access required
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.Show fields
- •String!required
The identifier for the metafield.
- Anchor to namespacenamespace•String
The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Arguments
- •String!
- Anchor to metafieldsmetafields•[Metafield]!non-null Token access required
A list of custom fields that a merchant associates with a Shopify resource.
Show fields
- Anchor to identifiersidentifiers•[Has
Metafields Identifier!]! required The list of metafields to retrieve by namespace and key.
The input must not contain more than
250values.Show input fields
Arguments
- Anchor to moneyFormatmoney•String!
Format non-null A string representing the way currency is formatted when the currency isn’t specified.
- Anchor to namename•String!non-null
The shop’s name.
- Anchor to paymentSettingspayment•Payment
Settings Settings! non-null Settings related to payments.
Show fields
- Anchor to primaryDomainprimary•Domain!
Domain non-null The primary domain of the shop’s Online Store.
Show fields
- Anchor to privacyPolicyprivacy•Shop
Policy Policy The shop’s privacy policy.
Show fields
- Anchor to sanitizedsanitized•BooleanDefault:false
Sanitize the policy content.
Arguments
- Anchor to refundPolicyrefund•Shop
Policy Policy The shop’s refund policy.
Show fields
- Anchor to sanitizedsanitized•BooleanDefault:false
Sanitize the policy content.
Arguments
- Anchor to shippingPolicyshipping•Shop
Policy Policy The shop’s shipping policy.
Show fields
- Anchor to sanitizedsanitized•BooleanDefault:false
Sanitize the policy content.
Arguments
- Anchor to shipsToCountriesships•[Country
To Countries Code!]! non-null Countries that the shop ships to.
Show enum values
- Anchor to shopPayInstallmentsPricingshop•Shop
Pay Installments Pricing Pay Installments Pricing Token access required The Shop Pay Installments pricing information for the shop.
Show fields
- •[Social
Login Provider!]! non-null The social login providers for customer accounts.
Show fields
- Anchor to subscriptionPolicysubscription•Shop
Policy Policy With Default The shop’s subscription policy.
Show fields
- Anchor to sanitizedsanitized•BooleanDefault:false
Sanitize the policy content.
Arguments
- Anchor to termsOfSaleterms•Shop
Of Sale Policy The shop's terms of sale.
Show fields
- Anchor to sanitizedsanitized•BooleanDefault:false
Sanitize the policy content.
Arguments
- Anchor to termsOfServiceterms•Shop
Of Service Policy The shop’s terms of service.
Show fields
- Anchor to sanitizedsanitized•BooleanDefault:false
Sanitize the policy content.
Arguments
Anchor to QueriesQueries
- shop (Shop!)
- •query
Returns the
Shopassociated with the storefront access token. TheShopobject provides general store information such as the shop name, description, and primary domain.Use this query to access data like store policies,
,Brandconfiguration, and shipping destinations. It also exposesandoptions for customer accounts.Show fields