Shop

object

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

Anchor to Fields and connectionsFields and connections

Anchor to accountOwneraccountOwner • StaffMember!non-null: Account owner information.
Anchor to alertsalerts • [ShopAlert!]!non-null: A list of the shop's active alert messages that appear in the Shopify admin.
Anchor to allProductCategoriesListallProductCategoriesList • [TaxonomyCategory!]!non-null: A list of the shop's product categories. Limit: 1000 product categories.
Anchor to availableChannelAppsavailableChannelApps • AppConnection!non-null: The list of sales channels not currently installed on the shop.
Anchor to billingAddressbillingAddress • ShopAddress!non-null: The shop's billing address information.
Anchor to channelDefinitionsForInstalledChannelschannelDefinitionsForInstalledChannels • [AvailableChannelDefinitionsByChannel!]!non-null: List of all channel definitions associated with a shop.
Anchor to checkoutApiSupportedcheckoutApiSupported • Boolean!non-null: Specifies whether the shop supports checkouts via Checkout API.
Anchor to contactEmailcontactEmail • String!non-null: The public-facing contact email address for the shop. Customers will use this email to communicate with the shop owner.
Anchor to countriesInShippingZonescountriesInShippingZones • CountriesInShippingZones!non-null: Countries that have been defined in shipping zones for the shop.
Anchor to createdAtcreatedAt • DateTime!non-null: The date and time when the shop was created.
Anchor to currencyCodecurrencyCode • CurrencyCode!non-null: The three letter code for the currency that the shop sells in.
Anchor to currencyFormatscurrencyFormats • CurrencyFormats!non-null: How currencies are displayed on your store.
Anchor to currencySettingscurrencySettings • CurrencySettingConnection!non-null: The presentment currency settings for the shop excluding the shop's own currency.
Anchor to customerAccountscustomerAccounts • ShopCustomerAccountsSetting!non-null: Whether customer accounts are required, optional, or disabled for the shop.
Anchor to customerAccountsV2customerAccountsV2 • CustomerAccountsV2!non-null: Information about the shop's customer accounts.
Anchor to customerTagscustomerTags • StringConnection!non-null: A list of tags that have been added to customer accounts.
Anchor to descriptiondescription • String: The shop's meta description used in search engine results.
Anchor to draftOrderTagsdraftOrderTags • StringConnection!non-null: A list of tags that have been added to draft orders.
Anchor to emailemail • String!non-null: The shop owner's email address. Shopify will use this email address to communicate with the shop owner.
Anchor to enabledPresentmentCurrenciesenabledPresentmentCurrencies • [CurrencyCode!]!non-null: The presentment currencies enabled for the shop.
Anchor to featuresfeatures • ShopFeatures!non-null: The set of features enabled for the shop.
Anchor to fulfillmentServicesfulfillmentServices • [FulfillmentService!]!non-null: List of the shop's installed fulfillment services.
Anchor to ianaTimezoneianaTimezone • String!non-null: The shop's time zone as defined by the IANA.
Anchor to idid • ID!non-null: A globally-unique ID.
Anchor to marketingSmsConsentEnabledAtCheckoutmarketingSmsConsentEnabledAtCheckout • Boolean!non-null: Whether SMS marketing has been enabled on the shop's checkout configuration settings.
Anchor to merchantApprovalSignalsmerchantApprovalSignals • MerchantApprovalSignals: The approval signals for a shop to support onboarding to channel apps.
Anchor to metafieldmetafield • 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.
Anchor to metafieldsmetafields • MetafieldConnection!non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to myshopifyDomainmyshopifyDomain • String!non-null: The shop's .myshopify.com domain name.
Anchor to namename • String!non-null: The shop's name.
Anchor to navigationSettingsnavigationSettings • [NavigationItem!]!non-null: The shop's settings related to navigation.
Anchor to orderNumberFormatPrefixorderNumberFormatPrefix • String!non-null: The prefix that appears before order numbers.
Anchor to orderNumberFormatSuffixorderNumberFormatSuffix • String!non-null: The suffix that appears after order numbers.
Anchor to orderTagsorderTags • StringConnection!non-null: A list of tags that have been added to orders.
Anchor to paymentSettingspaymentSettings • PaymentSettings!non-null: The shop's settings related to payments.
Anchor to planplan • ShopPlan!non-null: The shop's billing plan.
Anchor to primaryDomainprimaryDomain • Domain!non-null: The primary domain of the shop's online store.
Anchor to resourceLimitsresourceLimits • 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.
Anchor to richTextEditorUrlrichTextEditorUrl • URL!non-null: The URL of the rich text editor that can be used for mobile devices.
Anchor to searchsearch • SearchResultConnection!non-null: Fetches a list of admin search results by a specified query.
Anchor to searchFilterssearchFilters • SearchFilterOptions!non-null: The list of search filter options for the shop. These can be used to filter productvisibility for the shop.
Anchor to setupRequiredsetupRequired • Boolean!non-null: Whether the shop has outstanding setup steps.
Anchor to shipsToCountriesshipsToCountries • [CountryCode!]!non-null: The list of countries that the shop ships to.
Anchor to shopOwnerNameshopOwnerName • String!non-null: The name of the shop owner.
Anchor to shopPoliciesshopPolicies • [ShopPolicy!]!non-null: The list of all legal policies associated with a shop.
Anchor to storefrontAccessTokensstorefrontAccessTokens • StorefrontAccessTokenConnection!non-null: The storefront access token of a private application. These are scoped per-application.
Anchor to taxesIncludedtaxesIncluded • Boolean!non-null: Whether applicable taxes are included in the shop's product prices.
Anchor to taxShippingtaxShipping • Boolean!non-null: Whether the shop charges taxes for shipping.
Anchor to timezoneAbbreviationtimezoneAbbreviation • String!non-null: The shop's time zone abbreviation.
Anchor to timezoneOffsettimezoneOffset • String!non-null: The shop's time zone offset.
Anchor to timezoneOffsetMinutestimezoneOffsetMinutes • Int!non-null: The shop's time zone offset expressed as a number of minutes.
Anchor to transactionalSmsDisabledtransactionalSmsDisabled • Boolean!non-null: Whether transactional SMS sent by Shopify have been disabled for a shop.
Anchor to translationstranslations • [Translation!]!non-null: The published translations associated with the resource.
Anchor to unitSystemunitSystem • UnitSystem!non-null: The shop's unit system for weights and measures.
Anchor to updatedAtupdatedAt • DateTime!non-null: The date and time when the shop was last updated.
Anchor to urlurl • URL!non-null: The URL of the shop's online store.
Anchor to weightUnitweightUnit • WeightUnit!non-null: The shop's primary unit of weight for products and shipping.

Show

deprecated fields and connections Deprecated

Anchor to allProductCategoriesallProductCategories • [ProductCategory!]!non-nullDeprecated: A list of the shop's product categories. Limit: 1000 product categories. Deprecated in API version 2024-07. Use allProductCategoriesList instead.
Anchor to analyticsTokenanalyticsToken • String!non-nullDeprecated: The token required to query the shop's reports or dashboards. Not supported anymore.
Anchor to assignedFulfillmentOrdersassignedFulfillmentOrders • 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
Anchor to channelschannels • ChannelConnection!non-nullDeprecated: List of the shop's active sales channels. Use QueryRoot.channels instead.
Anchor to collectionscollections • CollectionConnection!non-nullDeprecated: List of the shop's collections. Use QueryRoot.collections instead.
Anchor to customerscustomers • CustomerConnection!non-nullDeprecated: Customer accounts associated to the shop. Use QueryRoot.customers instead.
Anchor to domainsdomains • [Domain!]!non-nullDeprecated: The domains configured for the shop. Use domainsPaginated instead.
Anchor to draftOrdersdraftOrders • DraftOrderConnection!non-nullDeprecated: List of saved draft orders on the shop. Use QueryRoot.draftOrders instead.
Anchor to fulfillmentOrdersfulfillmentOrders • FulfillmentOrderConnection!non-nullDeprecated: The paginated list of merchant-managed and third-party fulfillment orders. Use QueryRoot.fulfillmentOrders instead.
Anchor to inventoryItemsinventoryItems • InventoryItemConnection!non-nullDeprecated: List of the shop's inventory items. Use QueryRoot.inventoryItems instead.
Anchor to limitedPendingOrderCountlimitedPendingOrderCount • LimitedPendingOrderCount!non-nullDeprecated: The number of pendings orders on the shop. Limited to a maximum of 10000. Use QueryRoot.pendingOrdersCount instead.
Anchor to locationslocations • LocationConnection!non-nullDeprecated: List of active locations of the shop. Use QueryRoot.locations instead.
Anchor to ordersorders • OrderConnection!non-nullDeprecated: A list of the shop's orders. Use QueryRoot.orders instead.
Anchor to productImagesproductImages • 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.
Anchor to productsproducts • ProductConnection!non-nullDeprecated: List of the shop's products. Use QueryRoot.products.
Anchor to productTagsproductTags • StringConnection!non-nullDeprecated: A list of tags that have been added to products. Use QueryRoot.productTags instead.
Anchor to productTypesproductTypes • StringConnection!non-nullDeprecated: The list of types added to products. Use QueryRoot.productTypes instead.
Anchor to productVariantsproductVariants • ProductVariantConnection!non-nullDeprecated: List of the shop's product variants. Use QueryRoot.productVariants instead.
Anchor to productVendorsproductVendors • StringConnection!non-nullDeprecated: The list of vendors added to products. Use QueryRoot.productVendors instead.
Anchor to publicationCountpublicationCount • Int!non-nullDeprecated: The number of publications for the shop. Use QueryRoot.publicationsCount instead.
Anchor to staffMembersstaffMembers • StaffMemberConnection!non-nullDeprecated: The paginated list of the shop's staff members. Use QueryRoot.staffMembers instead.
Anchor to storefrontUrlstorefrontUrl • URL!non-nullDeprecated: The URL of the shop's storefront. Use url instead.

Was this section helpful?

Anchor to QueriesQueries

Anchor to shop 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.

Was this section helpful?

Anchor to MutationsMutations

Anchor to collectionDelete collectionDelete • mutation: Deletes a collection.
Anchor to customerDelete customerDelete • mutation: Delete a customer. As of API version 2022-10, apps using protected customer data must meet the protected customer data requirements.
Anchor to delegateAccessTokenCreate delegateAccessTokenCreate • mutation: Creates a delegate access token.

To learn more about creating delegate access tokens, refer to Delegate OAuth access tokens to subsystems.
Anchor to delegateAccessTokenDestroy delegateAccessTokenDestroy • mutation: Destroys a delegate access token.
Anchor to productCreate productCreate • mutation: Creates a product with attributes such as title, description, and vendor. You can use the productCreate mutation to define options and values for products with product variants, such as different sizes or colors.

To create multiple product variants for a single product and manage prices, use the productVariantsBulkCreate mutation.

To create or update a product in a single request, use the productSet mutation.

Learn more about the product model and adding product data.
Anchor to productDelete productDelete • mutation: Deletes a product, including all associated variants and media.

As of API version 2023-01, if you need to delete a large product, such as one that has many variants that are active at several locations, you may encounter timeout errors. To avoid these timeout errors, you can instead use the asynchronous ProductDeleteAsync mutation.
Anchor to productDuplicate productDuplicate • mutation: Duplicates a product.

If you need to duplicate a large product, such as one that has many variants that are active at several locations, you might encounter timeout errors.

To avoid these timeout errors, you can instead duplicate the product asynchronously.

In API version 2024-10 and higher, include synchronous: false argument in this mutation to perform the duplication asynchronously.

In API version 2024-07 and lower, use the asynchronous ProductDuplicateAsyncV2.

Metafield values are not duplicated if the unique values capability is enabled.
Anchor to publishablePublish publishablePublish • mutation: Publishes a resource to a channel. If the resource is a product, then it's visible in the channel only if the product status is active. Products that are sold exclusively on subscription (requiresSellingPlan: true) can be published only on online stores.
Anchor to publishablePublishToCurrentChannel publishablePublishToCurrentChannel • mutation: Publishes a resource to current channel. If the resource is a product, then it's visible in the channel only if the product status is active. Products that are sold exclusively on subscription (requiresSellingPlan: true) can be published only on online stores.
Anchor to publishableUnpublish publishableUnpublish • mutation: Unpublishes a resource from a channel. If the resource is a product, then it's visible in the channel only if the product status is active.
Anchor to publishableUnpublishToCurrentChannel publishableUnpublishToCurrentChannel • mutation: Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is active.
Anchor to savedSearchDelete savedSearchDelete • mutation: Delete a saved search.
Anchor to storefrontAccessTokenCreate storefrontAccessTokenCreate • mutation: Creates a storefront access token for use with the Storefront API.

An app can have a maximum of 100 active storefront access tokens for each shop.

Get started with the Storefront API.

Show

deprecated mutations Deprecated

Anchor to collectionPublish collectionPublish • mutationDeprecated: Publishes a collection to a channel. Use publishablePublish instead.
Anchor to collectionUnpublish collectionUnpublish • mutationDeprecated: Unpublishes a collection. Use publishableUnpublish instead.
Anchor to productPublish productPublish • mutationDeprecated: Publishes a product. Products that are sold exclusively on subscription (requiresSellingPlan: true) can only be published on online stores. Use publishablePublish instead.
Anchor to productUnpublish productUnpublish • mutationDeprecated: Unpublishes a product. Use publishableUnpublish instead.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to HasMetafields HasMetafields • interface
Anchor to HasPublishedTranslations HasPublishedTranslations • interface
Anchor to Node Node • interface

Was this section helpful?