Shop
Represents a collection of general settings and information about the shop.
Anchor to Fields and connectionsFields and connections
- Anchor to accountOwneraccount•Staff
Owner Member!non-null Account owner information.
- Anchor to alertsalerts•[Shop
Alert!]!non-null A list of the shop's active alert messages that appear in the Shopify admin.
- Anchor to allProductCategoriesListall•[Taxonomy
Product Categories List Category!]!non-null A list of the shop's product categories. Limit: 1000 product categories.
- Anchor to availableChannelAppsavailable•App
Channel Apps Connection!non-null The list of sales channels not currently installed on the shop.
- Anchor to billingAddressbilling•Shop
Address Address!non-null The shop's billing address information.
- Anchor to channelDefinitionsForInstalledChannelschannel•[Available
Definitions For Installed Channels Channel Definitions By Channel!]!non-null List of all channel definitions associated with a shop.
- Anchor to checkoutApiSupportedcheckout•Boolean!non-null
Api Supported Specifies whether the shop supports checkouts via Checkout API.
- Anchor to contactEmailcontact•String!non-null
Email The public-facing contact email address for the shop. Customers will use this email to communicate with the shop owner.
- Anchor to countriesInShippingZonescountries•Countries
In Shipping Zones In Shipping Zones!non-null Countries that have been defined in shipping zones for the shop.
- Anchor to createdAtcreated•Date
At Time!non-null The date and time when the shop was created.
- Anchor to currencyCodecurrency•Currency
Code Code!non-null The three letter code for the currency that the shop sells in.
- Anchor to currencyFormatscurrency•Currency
Formats Formats!non-null How currencies are displayed on your store.
- Anchor to currencySettingscurrency•Currency
Settings Setting Connection!non-null The presentment currency settings for the shop excluding the shop's own currency.
- Anchor to customerAccountscustomer•Shop
Accounts Customer Accounts Setting!non-null Whether customer accounts are required, optional, or disabled for the shop.
- Anchor to customerAccountsV2customer•Customer
Accounts V2 Accounts V2!non-null Information about the shop's customer accounts.
- Anchor to customerTagscustomer•String
Tags Connection!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 draftOrderTagsdraft•String
Order Tags Connection!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 enabledPresentmentCurrenciesenabled•[Currency
Presentment Currencies Code!]!non-null The presentment currencies enabled for the shop.
- Anchor to featuresfeatures•Shop
Features!non-null The set of features enabled for the shop.
- Anchor to fulfillmentServicesfulfillment•[Fulfillment
Services Service!]!non-null List of the shop's installed fulfillment services.
- Anchor to ianaTimezoneiana•String!non-null
Timezone The shop's time zone as defined by the IANA.
- •ID!non-null
A globally-unique ID.
- Anchor to marketingSmsConsentEnabledAtCheckoutmarketing•Boolean!non-null
Sms Consent Enabled At Checkout Whether SMS marketing has been enabled on the shop's checkout configuration settings.
- Anchor to merchantApprovalSignalsmerchant•Merchant
Approval Signals Approval Signals The approval signals for a shop to support onboarding to channel apps.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•Metafield
Connection!non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to myshopifyDomainmyshopify•String!non-null
Domain The shop's .myshopify.com domain name.
- Anchor to namename•String!non-null
The shop's name.
- •[Navigation
Item!]!non-null The shop's settings related to navigation.
- Anchor to orderNumberFormatPrefixorder•String!non-null
Number Format Prefix The prefix that appears before order numbers.
- Anchor to orderNumberFormatSuffixorder•String!non-null
Number Format Suffix The suffix that appears after order numbers.
- Anchor to orderTagsorder•String
Tags Connection!non-null A list of tags that have been added to orders.
- Anchor to paymentSettingspayment•Payment
Settings Settings!non-null The shop's settings related to payments.
- Anchor to planplan•Shop
Plan!non-null The shop's billing plan.
- Anchor to primaryDomainprimary•Domain!non-null
Domain The primary domain of the shop's online store.
- Anchor to resourceLimitsresource•Shop
Limits Resource Limits!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 richTextEditorUrlrich•URL!non-null
Text Editor Url The URL of the rich text editor that can be used for mobile devices.
- Anchor to searchsearch•Search
Result Connection!non-null Fetches a list of admin search results by a specified query.
- Anchor to searchFilterssearch•Search
Filters Filter Options!non-null The list of search filter options for the shop. These can be used to filter productvisibility for the shop.
- Anchor to setupRequiredsetup•Boolean!non-null
Required Whether the shop has outstanding setup steps.
- Anchor to shipsToCountriesships•[Country
To Countries Code!]!non-null The list of countries that the shop ships to.
- Anchor to shopOwnerNameshop•String!non-null
Owner Name The name of the shop owner.
- Anchor to shopPoliciesshop•[Shop
Policies Policy!]!non-null The list of all legal policies associated with a shop.
- Anchor to storefrontAccessTokensstorefront•Storefront
Access Tokens Access Token Connection!non-null The storefront access token of a private application. These are scoped per-application.
- Anchor to taxesIncludedtaxes•Boolean!non-null
Included Whether applicable taxes are included in the shop's product prices.
- Anchor to taxShippingtax•Boolean!non-null
Shipping Whether the shop charges taxes for shipping.
- Anchor to timezoneAbbreviationtimezone•String!non-null
Abbreviation The shop's time zone abbreviation.
- Anchor to timezoneOffsettimezone•String!non-null
Offset The shop's time zone offset.
- Anchor to timezoneOffsetMinutestimezone•Int!non-null
Offset Minutes The shop's time zone offset expressed as a number of minutes.
- Anchor to transactionalSmsDisabledtransactional•Boolean!non-null
Sms Disabled 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 unitSystemunit•Unit
System System!non-null The shop's unit system for weights and measures.
- Anchor to updatedAtupdated•Date
At Time!non-null The date and time when the shop was last updated.
- •URL!non-null
The URL of the shop's online store.
- Anchor to weightUnitweight•Weight
Unit Unit!non-null The shop's primary unit of weight for products and shipping.
Deprecated fields and connections
- Anchor to allProductCategoriesall•[Product
Product Categories Category!]!non-nullDeprecated - Anchor to analyticsTokenanalytics•String!non-nullDeprecated
Token - Anchor to assignedFulfillmentOrdersassigned•Fulfillment
Fulfillment Orders Order Connection!non-nullDeprecated - Anchor to channelschannels•Channel
Connection!non-nullDeprecated - Anchor to collectionscollections•Collection
Connection!non-nullDeprecated - Anchor to customerscustomers•Customer
Connection!non-nullDeprecated - Anchor to domainsdomains•[Domain!]!non-nullDeprecated
- Anchor to draftOrdersdraft•Draft
Orders Order Connection!non-nullDeprecated - Anchor to fulfillmentOrdersfulfillment•Fulfillment
Orders Order Connection!non-nullDeprecated - Anchor to inventoryItemsinventory•Inventory
Items Item Connection!non-nullDeprecated - Anchor to limitedPendingOrderCountlimited•Limited
Pending Order Count Pending Order Count!non-nullDeprecated - Anchor to locationslocations•Location
Connection!non-nullDeprecated - Anchor to ordersorders•Order
Connection!non-nullDeprecated - Anchor to productImagesproduct•Image
Images Connection!non-nullDeprecated - Anchor to productsproducts•Product
Connection!non-nullDeprecated - Anchor to productTagsproduct•String
Tags Connection!non-nullDeprecated - Anchor to productTypesproduct•String
Types Connection!non-nullDeprecated - Anchor to productVariantsproduct•Product
Variants Variant Connection!non-nullDeprecated - Anchor to productVendorsproduct•String
Vendors Connection!non-nullDeprecated - Anchor to publicationCountpublication•Int!non-nullDeprecated
Count - Anchor to staffMembersstaff•Staff
Members Member Connection!non-nullDeprecated - Anchor to storefrontUrlstorefront•URL!non-nullDeprecated
Url
Anchor to QueriesQueries
- •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 MutationsMutations
- •mutation
Deletes a collection.
- Anchor to inputinput•Collection
Delete Input!required The collection to delete.
Arguments
- Anchor to deletedCollectionIddeleted•ID
Collection Id The ID of the collection that was deleted. Returns
nullif the collection doesn't exist.- Anchor to shopshop•Shop!non-null
The shop associated with the collection.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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•Customer
Delete Input!required Specifies the customer to delete.
Arguments
- Anchor to deletedCustomerIddeleted•ID
Customer Id The ID of the deleted customer.
- Anchor to shopshop•Shop!non-null
The shop of the deleted customer.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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•Delegate
Access Token Input!required The input fields for creating a delegate access token.
Arguments
- Anchor to delegateAccessTokendelegate•Delegate
Access Token Access Token The delegate access token.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•[Delegate
Errors Access Token Create User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Destroys a delegate access token.
- Anchor to accessTokenaccess•String!required
Token Provides the delegate access token to destroy.
Arguments
- 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 userErrorsuser•[Delegate
Errors Access Token Destroy User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates a product with attributes such as title, description, and vendor. You can use the
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
mutation.To create or update a product in a single request, use the
mutation.Learn more about the product model and adding product data.
- Anchor to inputinput•Product
InputDeprecated - Anchor to mediamedia•[Create
Media Input!] The media to add to the product.
- Anchor to productproduct•Product
Create Input The attributes of the new product.
Arguments
- Anchor to productproduct•Product
The product object.
- Anchor to shopshop•Shop!non-null
The shop associated with the product.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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•Product
Delete Input!required Specifies the product to delete by its ID.
- Anchor to synchronoussynchronous•BooleanDefault:true
Specifies whether or not to run the mutation synchronously.
Arguments
- Anchor to deletedProductIddeleted•ID
Product Id The ID of the deleted product.
- Anchor to productDeleteOperationproduct•Product
Delete Operation Delete Operation The product delete operation, returned when run in asynchronous mode.
- Anchor to shopshop•Shop!non-null
The shop associated with the product.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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: falseargument in this mutation to perform the duplication asynchronously.In API version 2024-07 and lower, use the asynchronous
.Metafield values are not duplicated if the unique values capability is enabled.
- Anchor to includeImagesinclude•BooleanDefault:false
Images Specifies whether or not to duplicate images.
- Anchor to includeTranslationsinclude•BooleanDefault:false
Translations Specifies whether or not to duplicate translations.
- Anchor to newStatusnew•Product
Status Status The new status of the product. If no value is provided the status will be inherited from the original product.
- Anchor to newTitlenew•String!required
Title The new title of the product.
- Anchor to productIdproduct•ID!required
Id The ID of the product to be duplicated.
- Anchor to synchronoussynchronous•BooleanDefault:true
Specifies whether or not to run the mutation synchronously.
Arguments
- Anchor to imageJobimage•Job
Job The asynchronous job that duplicates the product images.
- Anchor to newProductnew•Product
Product The duplicated product.
- Anchor to productDuplicateOperationproduct•Product
Duplicate Operation Duplicate Operation The product duplicate operation, returned when run in asynchronous mode.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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 () can be published only on online stores.- •ID!required
The resource to create or update publications for.
- Anchor to inputinput•[Publication
Input!]!required Specifies the input fields required to publish a resource.
Arguments
- Anchor to publishablepublishable•Publishable
Resource that has been published.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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 () can be published only on online stores.- •ID!required
The resource to create or update publications for.
Arguments
- Anchor to publishablepublishable•Publishable
Resource that has been published.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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.- •ID!required
The resource to delete or update publications for.
- Anchor to inputinput•[Publication
Input!]!required Specifies the input fields required to unpublish a resource.
Arguments
- Anchor to publishablepublishable•Publishable
Resource that has been unpublished.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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.- •ID!required
The resource to delete or update publications for.
Arguments
- Anchor to publishablepublishable•Publishable
Resource that has been unpublished.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Delete a saved search.
- Anchor to inputinput•Saved
Search Delete Input!required The input fields to delete a saved search.
Arguments
- Anchor to deletedSavedSearchIddeleted•ID
Saved Search 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 userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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.
- Anchor to inputinput•Storefront
Access Token Input!required Provides the input fields for creating a storefront access token.
Arguments
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to storefrontAccessTokenstorefront•Storefront
Access Token Access Token The storefront access token.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
Deprecated mutations
- •mutationDeprecated
- •mutationDeprecated
- •mutationDeprecated
- •mutationDeprecated