Shop
Represents a collection of general settings and information about the shop.
Anchor to Fields and connectionsFields and connections
- 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•
Product Categories List [TaxonomyCategory!]!non-null A list of the shop's product categories. Limit: 1000 product categories.
- Anchor to availableChannelAppsavailable•
Channel Apps AppConnection!non-null The list of sales channels not currently installed on the shop.
- Anchor to billingAddressbilling•
Address ShopAddress!non-null The shop's billing address information.
- Anchor to channelDefinitionsForInstalledChannelschannel•
Definitions For Installed Channels List of all channel definitions associated with a shop.
- Anchor to checkoutApiSupportedcheckout•
Api Supported Boolean!non-null Specifies whether the shop supports checkouts via Checkout API.
- Anchor to contactEmailcontact•
Email 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 countriesInShippingZonescountries•
In Shipping Zones CountriesIn Shipping Zones!non-null Countries that have been defined in shipping zones for the shop.
- Anchor to createdAtcreated•
At DateTime!non-null The date and time when the shop was created.
- Anchor to currencyCodecurrency•
Code CurrencyCode!non-null The three letter code for the currency that the shop sells in.
- Anchor to currencyFormatscurrency•
Formats CurrencyFormats!non-null How currencies are displayed on your store.
- Anchor to currencySettingscurrency•
Settings CurrencySetting Connection!non-null The presentment currency settings for the shop excluding the shop's own currency.
- Anchor to customerAccountscustomer•
Accounts ShopCustomer Accounts Setting!non-null Whether customer accounts are required, optional, or disabled for the shop.
- Anchor to customerAccountsV2customer•
Accounts V2 CustomerAccounts V2!non-null Information about the shop's customer accounts.
- Anchor to customerTagscustomer•
Tags StringConnection!non-null A list of tags that have been added to customer accounts.
- Anchor to descriptiondescription•
The shop's meta description used in search engine results.
- Anchor to draftOrderTagsdraft•
Order Tags 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 enabledPresentmentCurrenciesenabled•
Presentment Currencies [CurrencyCode!]!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•
Services [FulfillmentService!]!non-null List of the shop's installed fulfillment services.
- Anchor to ianaTimezoneiana•
Timezone String!non-null The shop's time zone as defined by the IANA.
- •ID!non-null
A globally-unique ID.
- Anchor to marketingSmsConsentEnabledAtCheckoutmarketing•
Sms Consent Enabled At Checkout Boolean!non-null Whether SMS marketing has been enabled on the shop's checkout configuration settings.
- Anchor to merchantApprovalSignalsmerchant•
Approval Signals The approval signals for a shop to support onboarding to channel apps.
- Anchor to metafieldmetafield•
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•
Domain String!non-null 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•
Number Format Prefix String!non-null The prefix that appears before order numbers.
- Anchor to orderNumberFormatSuffixorder•
Number Format Suffix String!non-null The suffix that appears after order numbers.
- Anchor to orderTagsorder•
Tags StringConnection!non-null A list of tags that have been added to orders.
- Anchor to paymentSettingspayment•
Settings PaymentSettings!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 Domain!non-null The primary domain of the shop's online store.
- Anchor to resourceLimitsresource•
Limits ShopResource 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•
Text Editor Url URL!non-null 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•
Filters SearchFilter 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•
Required Boolean!non-null Whether the shop has outstanding setup steps.
- Anchor to shipsToCountriesships•
To Countries [CountryCode!]!non-null The list of countries that the shop ships to.
- Anchor to shopPoliciesshop•
Policies [ShopPolicy!]!non-null The list of all legal policies associated with a shop.
- Anchor to storefrontAccessTokensstorefront•
Access Tokens StorefrontAccess Token Connection!non-null The storefront access token of a private application. These are scoped per-application.
- Anchor to taxesIncludedtaxes•
Included Boolean!non-null Whether applicable taxes are included in the shop's product prices.
- Anchor to taxShippingtax•
Shipping Boolean!non-null Whether the shop charges taxes for shipping.
- Anchor to timezoneAbbreviationtimezone•
Abbreviation String!non-null The shop's time zone abbreviation.
- Anchor to timezoneOffsettimezone•
Offset String!non-null The shop's time zone offset.
- Anchor to timezoneOffsetMinutestimezone•
Offset Minutes Int!non-null The shop's time zone offset expressed as a number of minutes.
- Anchor to transactionalSmsDisabledtransactional•
Sms Disabled 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 unitSystemunit•
System UnitSystem!non-null The shop's unit system for weights and measures.
- Anchor to updatedAtupdated•
At DateTime!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•
Unit WeightUnit!non-null The shop's primary unit of weight for products and shipping.
Deprecated fields and connections
- Anchor to allProductCategoriesall•
Product Categories [ProductCategory!]!non-null A list of the shop's product categories. Limit: 1000 product categories.
- Anchor to analyticsTokenanalytics•
Token String!non-null The token required to query the shop's reports or dashboards.
- Anchor to assignedFulfillmentOrdersassigned•
Fulfillment Orders FulfillmentOrder Connection!non-null 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
access scope to be able to retrieve fulfillment orders assigned to its locations.All assigned fulfillment orders (except those with the
status) will be returned by default. Perform filtering with theargument to receive only fulfillment orders that have been requested to be fulfilled.- Anchor to channelschannels•Channel
Connection!non-null List of the shop's active sales channels.
- Anchor to collectionByHandlecollection•
By Handle Return a collection by its handle.
- Anchor to collectionscollections•Collection
Connection!non-null List of the shop's collections.
- Anchor to collectionSavedSearchescollection•
Saved Searches SavedSearch Connection!non-null List of the shop's collection saved searches.
- Anchor to customerscustomers•Customer
Connection!non-null Customer accounts associated to the shop.
- Anchor to customerSavedSearchescustomer•
Saved Searches SavedSearch Connection!non-null List of the shop's customer saved searches.
- Anchor to domainsdomains•[Domain!]!non-null
The domains configured for the shop.
- Anchor to draftOrdersdraft•
Orders DraftOrder Connection!non-null List of saved draft orders on the shop.
- Anchor to draftOrderSavedSearchesdraft•
Order Saved Searches SavedSearch Connection!non-null List of the shop's draft order saved searches.
- Anchor to fulfillmentOrdersfulfillment•
Orders FulfillmentOrder Connection!non-null The paginated list of merchant-managed and third-party fulfillment orders.
- Anchor to inventoryItemsinventory•
Items InventoryItem Connection!non-null List of the shop's inventory items.
- Anchor to limitedPendingOrderCountlimited•
Pending Order Count LimitedPending Order Count!non-null The number of pendings orders on the shop. Limited to a maximum of 10000.
- Anchor to locationslocations•Location
Connection!non-null List of active locations of the shop.
- Anchor to marketingEventsmarketing•
Events MarketingEvent Connection!non-null List of a shop's marketing events.
- Anchor to ordersorders•Order
Connection!non-null A list of the shop's orders.
- Anchor to orderSavedSearchesorder•
Saved Searches SavedSearch Connection!non-null List of the shop's order saved searches.
- Anchor to priceRulesprice•
Rules PriceRule Connection!non-null List of the shop’s price rules.
- Anchor to priceRuleSavedSearchesprice•
Rule Saved Searches SavedSearch Connection!non-null List of the shop's price rule saved searches.
- Anchor to privateMetafieldprivate•
Metafield Returns a private metafield by namespace and key that belongs to the resource.
- Anchor to privateMetafieldsprivate•
Metafields PrivateMetafield Connection!non-null List of private metafields that belong to the resource.
- Anchor to productByHandleproduct•
By Handle Return a product by its handle.
- Anchor to productImagesproduct•
Images ImageConnection!non-null The list of all images of all products for the shop.
- Anchor to productsproducts•Product
Connection!non-null List of the shop's products.
- Anchor to productSavedSearchesproduct•
Saved Searches SavedSearch Connection!non-null List of the shop's product saved searches.
- Anchor to productTagsproduct•
Tags StringConnection!non-null A list of tags that have been added to products.
- Anchor to productTypesproduct•
Types StringConnection!non-null The list of types added to products.
- Anchor to productVariantsproduct•
Variants ProductVariant Connection!non-null List of the shop's product variants.
- Anchor to productVendorsproduct•
Vendors StringConnection!non-null The list of vendors added to products.
- Anchor to publicationCountpublication•
Count Int!non-null The number of publications for the shop.
- Anchor to staffMembersstaff•
Members StaffMember Connection!non-null The paginated list of the shop's staff members.
- Anchor to storefrontUrlstorefront•
Url URL!non-null The URL of the shop's storefront.
- Anchor to uploadedImagesByIdsuploaded•
Images By Ids [Image!]!non-null Fetches a list of images uploaded to the shop by their IDs.
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•
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•
Errors [UserError!]!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•
Customer Id The ID of the deleted customer.
- Anchor to shopshop•Shop!non-null
The shop of the deleted customer.
- Anchor to userErrorsuser•
Errors [UserError!]!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•
Access Token The delegate access token.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•
Errors The list of errors that occurred from executing the mutation.
Fields
- •mutation
Destroys a delegate access token.
- Anchor to accessTokenaccess•
Token String!required Provides the delegate access token to destroy.
Arguments
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to statusstatus•
The status of the delegate access token destroy operation. Returns true if successful.
- Anchor to userErrorsuser•
Errors 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
Input!required The properties of the new product.
- Anchor to mediamedia•
The media to add to the product.
Arguments
- Anchor to productproduct•
The product object.
- Anchor to shopshop•Shop!non-null
The shop associated with the product.
- Anchor to userErrorsuser•
Errors [UserError!]!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.
Arguments
- Anchor to deletedProductIddeleted•
Product Id The ID of the deleted product.
- Anchor to shopshop•Shop!non-null
The shop associated with the product.
- Anchor to userErrorsuser•
Errors [UserError!]!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•
Images BooleanDefault:false Specifies whether or not to duplicate images.
- Anchor to includeTranslationsinclude•
Translations BooleanDefault:false Specifies whether or not to duplicate translations.
- Anchor to newStatusnew•
Status The new status of the product. If no value is provided the status will be inherited from the original product.
- Anchor to newTitlenew•
Title String!required The new title of the product.
- Anchor to productIdproduct•
Id ID!required The ID of the product to be duplicated.
Arguments
- Anchor to imageJobimage•
Job The asynchronous job that duplicates the product images.
- Anchor to newProductnew•
Product The duplicated product.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•
Errors [UserError!]!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•
Resource that has been published.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•
Errors [UserError!]!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•
Resource that has been published.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•
Errors [UserError!]!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•
Resource that has been unpublished.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•
Errors [UserError!]!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•
Resource that has been unpublished.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•
Errors [UserError!]!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•
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•
Errors [UserError!]!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•
Access Token The storefront access token.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
Deprecated mutations
- •mutation
Publishes a collection to a channel.
- Anchor to inputinput•Collection
Publish Input!required Specify a collection to publish and the sales channels to publish it to.
Arguments
- Anchor to collectioncollection•
The published collection.
- Anchor to collectionPublicationscollection•
Publications The channels where the collection has been published.
- Anchor to shopshop•Shop!non-null
The shop associated with the collection.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Unpublishes a collection.
- Anchor to inputinput•Collection
Unpublish Input!required Specify a collection to unpublish and the sales channels to remove it from.
Arguments
- Anchor to collectioncollection•
The collection that has been unpublished.
- Anchor to shopshop•Shop!non-null
The shop associated with the collection.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Delete a price rule.
- •ID!required
The ID of the price rule object.
Arguments
- Anchor to deletedPriceRuleIddeleted•
Price Rule Id The ID price of the deleted price rule.
- Anchor to priceRuleUserErrorsprice•
Rule User Errors [PriceRule User Error!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to shopshop•Shop!non-null
The shop of the deleted price rule.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Publishes a product. Products that are sold exclusively on subscription (
) can only be published on online stores.- Anchor to inputinput•Product
Publish Input!required Specifies the product to publish and the channels to publish it to.
Arguments
- Anchor to productproduct•
The product that has been published.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to productPublicationsproduct•
Publications The channels where the product is published.
Fields
- •mutation
Unpublishes a product.
- Anchor to inputinput•Product
Unpublish Input!required Specifies the product to unpublish and the channel to unpublish it from.
Arguments
- Anchor to productproduct•
The product that has been unpublished.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields