Choose a version:

shop

query

Returns the Shop resource corresponding to the access token used in the request. The Shop resource contains business and store management settings for the shop.

Anchor to Possible returnsPossible returns

Shop

•

Shop!

Represents a collection of general settings and information about the shop.

alerts• [ShopAlert!]! non-null: A list of the shop's active alert messages that appear in the Shopify admin.
allProductCategoriesList• [TaxonomyCategory!]! non-null: A list of the shop's product categories. Limit: 1000 product categories.
availableChannelApps • AppConnection! non-null: The list of sales channels not currently installed on the shop.
billingAddress• ShopAddress! non-null: The shop's billing address information.
channelDefinitionsForInstalledChannels• [AvailableChannelDefinitionsByChannel!]! non-null: List of all channel definitions associated with a shop.
checkoutApiSupported• Boolean! non-null: Specifies whether the shop supports checkouts via Checkout API.
contactEmail• String! non-null: The public-facing contact email address for the shop. Customers will use this email to communicate with the shop owner.
countriesInShippingZones• CountriesInShippingZones! non-null: Countries that have been defined in shipping zones for the shop.
createdAt• DateTime! non-null: The date and time when the shop was created.
currencyCode• CurrencyCode! non-null: The three letter code for the currency that the shop sells in.
currencyFormats• CurrencyFormats! non-null: How currencies are displayed on your store.
currencySettings • CurrencySettingConnection! non-null: The presentment currency settings for the shop excluding the shop's own currency.
customerAccounts• ShopCustomerAccountsSetting! non-null: Whether customer accounts are required, optional, or disabled for the shop.
customerAccountsV2• CustomerAccountsV2! non-null: Information about the shop's customer accounts.
customerTags • StringConnection! non-null: A list of tags that have been added to customer accounts.
description• String: The shop's meta description used in search engine results.
draftOrderTags • StringConnection! non-null: A list of tags that have been added to draft orders.
email• String! non-null: The shop owner's email address. Shopify will use this email address to communicate with the shop owner.
enabledPresentmentCurrencies• [CurrencyCode!]! non-null: The presentment currencies enabled for the shop.
features• ShopFeatures! non-null: The set of features enabled for the shop.
fulfillmentServices• [FulfillmentService!]! non-null: List of the shop's installed fulfillment services.
ianaTimezone• String! non-null: The shop's time zone as defined by the IANA.
id• ID! non-null: A globally-unique ID.
marketingSmsConsentEnabledAtCheckout• Boolean! non-null: Whether SMS marketing has been enabled on the shop's checkout configuration settings.
merchantApprovalSignals• MerchantApprovalSignals: The approval signals for a shop to support onboarding to channel apps.
metafield• 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.
metafields • MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
myshopifyDomain• String! non-null: The shop's .myshopify.com domain name.
name• String! non-null: The shop's name.
navigationSettings• [NavigationItem!]! non-null: The shop's settings related to navigation.
orderNumberFormatPrefix• String! non-null: The prefix that appears before order numbers.
orderNumberFormatSuffix• String! non-null: The suffix that appears after order numbers.
orderTags • StringConnection! non-null: A list of tags that have been added to orders.
paymentSettings• PaymentSettings! non-null: The shop's settings related to payments.
plan• ShopPlan! non-null: The shop's billing plan.
primaryDomain• Domain! non-null: The primary domain of the shop's online store.
resourceLimits• ShopResourceLimits! non-null: The shop's limits for specific resources. For example, the maximum number ofvariants allowed per product, or the maximum number of locations allowed.
richTextEditorUrl• URL! non-null: The URL of the rich text editor that can be used for mobile devices.
search • SearchResultConnection! non-null: Fetches a list of admin search results by a specified query.
searchFilters• SearchFilterOptions! non-null: The list of search filter options for the shop. These can be used to filter productvisibility for the shop.
setupRequired• Boolean! non-null: Whether the shop has outstanding setup steps.
shipsToCountries• [CountryCode!]! non-null: The list of countries that the shop ships to.
shopPolicies• [ShopPolicy!]! non-null: The list of all legal policies associated with a shop.
storefrontAccessTokens • StorefrontAccessTokenConnection! non-null: The storefront access token of a private application. These are scoped per-application.
taxesIncluded• Boolean! non-null: Whether applicable taxes are included in the shop's product prices.
taxShipping• Boolean! non-null: Whether the shop charges taxes for shipping.
timezoneAbbreviation• String! non-null: The shop's time zone abbreviation.
timezoneOffset• String! non-null: The shop's time zone offset.
timezoneOffsetMinutes• Int! non-null: The shop's time zone offset expressed as a number of minutes.
transactionalSmsDisabled• Boolean! non-null: Whether transactional SMS sent by Shopify have been disabled for a shop.
translations• [Translation!]! non-null: The published translations associated with the resource.
unitSystem• UnitSystem! non-null: The shop's unit system for weights and measures.
updatedAt• DateTime! non-null: The date and time when the shop was last updated.
url• URL! non-null: The URL of the shop's online store.
weightUnit• WeightUnit! non-null: The shop's primary unit of weight for products and shipping.
allProductCategories• [ProductCategory!]! non-nullDeprecated: A list of the shop's product categories. Limit: 1000 product categories. Deprecated in API version 2024-07. Use allProductCategoriesList instead.
analyticsToken• String! non-nullDeprecated: The token required to query the shop's reports or dashboards. Not supported anymore.
assignedFulfillmentOrders • FulfillmentOrderConnection! non-nullDeprecated: The paginated list of fulfillment orders assigned to the shop locations owned by the app.

Assigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations managed by fulfillment services that are registered by the app. One app (api_client) can host multiple fulfillment services on a shop. Each fulfillment service manages a dedicated location on a shop. Assigned fulfillment orders can have associated fulfillment requests, or might currently not be requested to be fulfilled.

The app must have read_assigned_fulfillment_orders access scope to be able to retrieve fulfillment orders assigned to its locations.

All assigned fulfillment orders (except those with the CLOSED status) will be returned by default. Perform filtering with the assignmentStatus argument to receive only fulfillment orders that have been requested to be fulfilled. Use QueryRoot.assignedFulfillmentOrders instead. Details: https://shopify.dev/changelog/moving-the-shop-assignedfulfillmentorders-connection-to-queryroot
channels • ChannelConnection! non-nullDeprecated: List of the shop's active sales channels. Use QueryRoot.channels instead.
collectionByHandle• Collection Deprecated: Return a collection by its handle. Use QueryRoot.collectionByHandle instead.
collections • CollectionConnection! non-nullDeprecated: List of the shop's collections. Use QueryRoot.collections instead.
collectionSavedSearches • SavedSearchConnection! non-nullDeprecated: List of the shop's collection saved searches. Use QueryRoot.collectionSavedSearches instead.
customers • CustomerConnection! non-nullDeprecated: Customer accounts associated to the shop. Use QueryRoot.customers instead.
customerSavedSearches • SavedSearchConnection! non-nullDeprecated: List of the shop's customer saved searches. Use QueryRoot.customerSavedSearches instead.
domains• [Domain!]! non-nullDeprecated: The domains configured for the shop. Use domainsPaginated instead.
draftOrders • DraftOrderConnection! non-nullDeprecated: List of saved draft orders on the shop. Use QueryRoot.draftOrders instead.
draftOrderSavedSearches • SavedSearchConnection! non-nullDeprecated: List of the shop's draft order saved searches. Use QueryRoot.draftOrderSavedSearches instead.
fulfillmentOrders • FulfillmentOrderConnection! non-nullDeprecated: The paginated list of merchant-managed and third-party fulfillment orders. Use QueryRoot.fulfillmentOrders instead.
inventoryItems • InventoryItemConnection! non-nullDeprecated: List of the shop's inventory items. Use QueryRoot.inventoryItems instead.
limitedPendingOrderCount• LimitedPendingOrderCount! non-nullDeprecated: The number of pendings orders on the shop. Limited to a maximum of 10000. Use QueryRoot.pendingOrdersCount instead.
locations • LocationConnection! non-nullDeprecated: List of active locations of the shop. Use QueryRoot.locations instead.
marketingEvents • MarketingEventConnection! non-nullDeprecated: List of a shop's marketing events. Use QueryRoot.marketingEvents instead.
orders • OrderConnection! non-nullDeprecated: A list of the shop's orders. Use QueryRoot.orders instead.
orderSavedSearches • SavedSearchConnection! non-nullDeprecated: List of the shop's order saved searches. Use QueryRoot.orderSavedSearches instead.
priceRules • PriceRuleConnection! non-nullDeprecated: List of the shop’s price rules. Use QueryRoot.priceRules instead.
priceRuleSavedSearches • SavedSearchConnection! non-nullDeprecated: List of the shop's price rule saved searches. Use QueryRoot.priceRuleSavedSearches instead.
privateMetafield• PrivateMetafield Deprecated: Returns a private metafield by namespace and key that belongs to the resource. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.
privateMetafields • PrivateMetafieldConnection! non-nullDeprecated: List of private metafields that belong to the resource. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.
productByHandle• Product Deprecated: Return a product by its handle. Use QueryRoot.productByHandle instead.
productImages • ImageConnection! non-nullDeprecated: The list of all images of all products for the shop. Use files instead. See filesQuery and its query argument for more information.
products • ProductConnection! non-nullDeprecated: List of the shop's products. Use QueryRoot.products.
productSavedSearches • SavedSearchConnection! non-nullDeprecated: List of the shop's product saved searches. Use QueryRoot.productSavedSearches instead.
productTags • StringConnection! non-nullDeprecated: A list of tags that have been added to products. Use QueryRoot.productTags instead.
productTypes • StringConnection! non-nullDeprecated: The list of types added to products. Use QueryRoot.productTypes instead.
productVariants • ProductVariantConnection! non-nullDeprecated: List of the shop's product variants. Use QueryRoot.productVariants instead.
productVendors • StringConnection! non-nullDeprecated: The list of vendors added to products. Use QueryRoot.productVendors instead.
publicationCount• Int! non-nullDeprecated: The number of publications for the shop. Use QueryRoot.publicationsCount instead.
staffMembers • StaffMemberConnection! non-nullDeprecated: The paginated list of the shop's staff members. Use QueryRoot.staffMembers instead.
storefrontUrl• URL! non-nullDeprecated: The URL of the shop's storefront. Use url instead.
uploadedImagesByIds• [Image!]! non-nullDeprecated: Fetches a list of images uploaded to the shop by their IDs. Use files instead. See filesQuery and its query argument for more information.

Was this section helpful?

Get a metafield attached to a shop
Get metafields attached to a shop
Receive a list of all FulfillmentServices
Retrieve information about a shop
Retrieves a list of fulfillment orders assigned to the shop locations that are owned by the app
Retrieves a list of all users
Retrieves a list of currencies enabled on a shop
Retrieves a list of storefront access tokens that have been issued
Retrieves a list of the shop's policies

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query ShopMetafield($namespace: String!, $key: String!) {

shop {

copyrightYear: metafield(namespace: $namespace, key: $key) {

value

}

}`,

{

variables: {

"namespace": "my_fields",

"key": "copyright_year"

);

const data = await response.json();

query ShopMetafield($namespace: String!, $key: String!) {
  shop {
    copyrightYear: metafield(namespace: $namespace, key: $key) {
      value
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query ShopMetafield($namespace: String!, $key: String!) { shop { copyrightYear: metafield(namespace: $namespace, key: $key) { value } } }",
 "variables": {
    "namespace": "my_fields",
    "key": "copyright_year"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query ShopMetafield($namespace: String!, $key: String!) {
    shop {
      copyrightYear: metafield(namespace: $namespace, key: $key) {
        value
      }
    }
  }`,
  {
    variables: {
      "namespace": "my_fields",
      "key": "copyright_year"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query ShopMetafield($namespace: String!, $key: String!) {
      shop {
        copyrightYear: metafield(namespace: $namespace, key: $key) {
          value
        }
      }
    }`,
    "variables": {
      "namespace": "my_fields",
      "key": "copyright_year"
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query ShopMetafield($namespace: String!, $key: String!) {
    shop {
      copyrightYear: metafield(namespace: $namespace, key: $key) {
        value
      }
    }
  }
QUERY

variables = {
  "namespace": "my_fields",
  "key": "copyright_year"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"namespace": "my_fields",

"key": "copyright_year"

}

Response

JSON

{

"shop": {

"copyrightYear": {

"value": "2022"

}