Choose a version:

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 entitlementsentitlements •EntitlementsType! non-null: The entitlements for a 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.

Deprecated fields and connections

Anchor to allProductCategoriesallProductCategories •[ProductCategory!]! non-nullDeprecated
Anchor to analyticsTokenanalyticsToken •String! non-nullDeprecated
Anchor to assignedFulfillmentOrdersassignedFulfillmentOrders •FulfillmentOrderConnection! non-nullDeprecated
Anchor to channelschannels •ChannelConnection! non-nullDeprecated
Anchor to collectionscollections •CollectionConnection! non-nullDeprecated
Anchor to customerscustomers •CustomerConnection! non-nullDeprecated
Anchor to domainsdomains •[Domain!]! non-nullDeprecated
Anchor to draftOrdersdraftOrders •DraftOrderConnection! non-nullDeprecated
Anchor to fulfillmentOrdersfulfillmentOrders •FulfillmentOrderConnection! non-nullDeprecated
Anchor to inventoryItemsinventoryItems •InventoryItemConnection! non-nullDeprecated
Anchor to limitedPendingOrderCountlimitedPendingOrderCount •LimitedPendingOrderCount! non-nullDeprecated
Anchor to locationslocations •LocationConnection! non-nullDeprecated
Anchor to ordersorders •OrderConnection! non-nullDeprecated
Anchor to productImagesproductImages •ImageConnection! non-nullDeprecated
Anchor to productsproducts •ProductConnection! non-nullDeprecated
Anchor to productTagsproductTags •StringConnection! non-nullDeprecated
Anchor to productTypesproductTypes •StringConnection! non-nullDeprecated
Anchor to productVariantsproductVariants •ProductVariantConnection! non-nullDeprecated
Anchor to productVendorsproductVendors •StringConnection! non-nullDeprecated
Anchor to publicationCountpublicationCount •Int! non-nullDeprecated
Anchor to staffMembersstaffMembers •StaffMemberConnection! non-nullDeprecated
Anchor to storefrontUrlstorefrontUrl •URL! non-nullDeprecated

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

collectionDelete

•mutation

Deletes a collection.

Anchor to inputinput •CollectionDeleteInput! required: The collection to delete.

Anchor to deletedCollectionIddeletedCollectionId •ID: The ID of the collection that was deleted. Returns null if the collection doesn't exist.
Anchor to shopshop •Shop! non-null: The shop associated with the collection.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

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 inputinput •CustomerDeleteInput! required: Specifies the customer to delete.

Anchor to deletedCustomerIddeletedCustomerId •ID: The ID of the deleted customer.
Anchor to shopshop •Shop! non-null: The shop of the deleted customer.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

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 inputinput •DelegateAccessTokenInput! required: The input fields for creating a delegate access token.

Anchor to delegateAccessTokendelegateAccessToken •DelegateAccessToken: The delegate access token.
Anchor to shopshop •Shop! non-null: The user's shop.
Anchor to userErrorsuserErrors •[DelegateAccessTokenCreateUserError!]! non-null: The list of errors that occurred from executing the mutation.

delegateAccessTokenDestroy

•mutation

Destroys a delegate access token.

Anchor to accessTokenaccessToken •String! required: Provides the delegate access token to destroy.

Anchor to shopshop •Shop! non-null: The user's shop.
Anchor to statusstatus •Boolean: The status of the delegate access token destroy operation. Returns true if successful.
Anchor to userErrorsuserErrors •[DelegateAccessTokenDestroyUserError!]! non-null: The list of errors that occurred from executing the mutation.

productCreate

•mutation

Creates a product with attributes such as title, description, vendor, and media.

The productCreate mutation helps you create many products at once, avoiding the tedious or time-consuming process of adding them one by one in the Shopify admin. Common examples include creating products for a new collection, launching a new product line, or adding seasonal products.

You can define product options and values, allowing you to create products with different variations like sizes or colors. You can also associate media files to your products, including images and videos.

The productCreate mutation only supports creating a product with its initial product variant. To create multiple product variants for a single product and manage prices, use the productVariantsBulkCreate mutation.

Note

The productCreate mutation has a throttle that takes effect when a store has 50,000 product variants. After this threshold is reached, no more than 1,000 new product variants can be created per day.

After you create a product, you can make subsequent edits to the product using one of the following mutations:

publishablePublish: Used to publish the product and make it available to customers. The productCreate mutation creates products in an unpublished state by default, so you must perform a separate operation to publish the product.
productUpdate: Used to update a single product, such as changing the product's title, description, vendor, or associated media.
productSet: Used to perform multiple operations on products, such as creating or modifying product options and variants.

Learn more about the product model and adding product data.

Anchor to inputinput •ProductInput Deprecated
Anchor to mediamedia •[CreateMediaInput!]: The media to add to the product.
Anchor to productproduct •ProductCreateInput: The attributes of the new product.

Anchor to productproduct •Product: The product object.
Anchor to shopshop •Shop! non-null: The shop associated with the product.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

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 inputinput •ProductDeleteInput! required: Specifies the product to delete by its ID.
Anchor to synchronoussynchronous •Boolean Default:true: Specifies whether or not to run the mutation synchronously.

Anchor to deletedProductIddeletedProductId •ID: The ID of the deleted product.
Anchor to productDeleteOperationproductDeleteOperation •ProductDeleteOperation: The product delete operation, returned when run in asynchronous mode.
Anchor to shopshop •Shop! non-null: The shop associated with the product.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

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 includeImagesincludeImages •Boolean Default:false: Specifies whether or not to duplicate images.
Anchor to includeTranslationsincludeTranslations •Boolean Default:false: Specifies whether or not to duplicate translations.
Anchor to newStatusnewStatus •ProductStatus: The new status of the product. If no value is provided the status will be inherited from the original product.
Anchor to newTitlenewTitle •String! required: The new title of the product.
Anchor to productIdproductId •ID! required: The ID of the product to be duplicated.
Anchor to synchronoussynchronous •Boolean Default:true: Specifies whether or not to run the mutation synchronously.

Anchor to imageJobimageJob •Job: The asynchronous job that duplicates the product images.
Anchor to newProductnewProduct •Product: The duplicated product.
Anchor to productDuplicateOperationproductDuplicateOperation •ProductDuplicateOperation: The product duplicate operation, returned when run in asynchronous mode.
Anchor to shopshop •Shop! non-null: The user's shop.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

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 idid •ID! required: The resource to create or update publications for.
Anchor to inputinput •[PublicationInput!]! required: Specifies the input fields required to publish a resource.

Anchor to publishablepublishable •Publishable: Resource that has been published.
Anchor to shopshop •Shop! non-null: The user's shop.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

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 idid •ID! required: The resource to create or update publications for.

Anchor to publishablepublishable •Publishable: Resource that has been published.
Anchor to shopshop •Shop! non-null: The user's shop.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

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 idid •ID! required: The resource to delete or update publications for.
Anchor to inputinput •[PublicationInput!]! required: Specifies the input fields required to unpublish a resource.

Anchor to publishablepublishable •Publishable: Resource that has been unpublished.
Anchor to shopshop •Shop! non-null: The user's shop.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

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 idid •ID! required: The resource to delete or update publications for.

Anchor to publishablepublishable •Publishable: Resource that has been unpublished.
Anchor to shopshop •Shop! non-null: The user's shop.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

savedSearchDelete

•mutation

Delete a saved search.

Anchor to inputinput •SavedSearchDeleteInput! required: The input fields to delete a saved search.

Anchor to deletedSavedSearchIddeletedSavedSearchId •ID: The ID of the saved search that was deleted.
Anchor to shopshop •Shop! non-null: The shop of the saved search that was deleted.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

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.

Anchor to inputinput •StorefrontAccessTokenInput! required: Provides the input fields for creating a storefront access token.

Anchor to shopshop •Shop! non-null: The user's shop.
Anchor to storefrontAccessTokenstorefrontAccessToken •StorefrontAccessToken: The storefront access token.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Deprecated mutations

collectionPublish

•mutation

Deprecated

Anchor to inputinput •CollectionPublishInput! required: Specify a collection to publish and the sales channels to publish it to.

Anchor to collectioncollection •Collection: The published collection.
Anchor to collectionPublicationscollectionPublications •[CollectionPublication!]: The channels where the collection has been published.
Anchor to shopshop •Shop! non-null: The shop associated with the collection.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

collectionUnpublish

•mutation

Deprecated

Anchor to inputinput •CollectionUnpublishInput! required: Specify a collection to unpublish and the sales channels to remove it from.

Anchor to collectioncollection •Collection: The collection that has been unpublished.
Anchor to shopshop •Shop! non-null: The shop associated with the collection.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

productPublish

•mutation

Deprecated

Anchor to inputinput •ProductPublishInput! required: Specifies the product to publish and the channels to publish it to.

Anchor to productproduct •Product: The product that has been published.
Anchor to shopshop •Shop! non-null: The user's shop.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.
Anchor to productPublicationsproductPublications •[ProductPublication!] Deprecated

productUnpublish

•mutation

Deprecated

Anchor to inputinput •ProductUnpublishInput! required: Specifies the product to unpublish and the channel to unpublish it from.

Anchor to productproduct •Product: The product that has been unpublished.
Anchor to shopshop •Shop! non-null: The user's shop.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

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?

Anchor to Fields and connectionsFields and connections

Deprecated fields and connections

Anchor to QueriesQueries

Anchor to MutationsMutations

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Deprecated mutations

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Anchor to InterfacesInterfaces