The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start.
Fields and connections
List of abandoned checkouts. Includes checkouts that were recovered after being abandoned.
Returns the count of abandoned checkouts for the given shop. Limited to a maximum of 10000.
Returns an abandonment by ID.
Returns an Abandonment by the Abandoned Checkout ID.
Lookup an App by ID or return the currently authenticated App.
Fetches app by handle. Returns null if the app doesn't exist.
Fetches an app by its client ID. Returns null if the app doesn't exist.
Credits that can be used towards future app purchases.
An app discount type.
A list of app discount types installed by apps.
Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App.
A list of app installations. To use this query, you need to contact Shopify Support to grant your custom app the
access scope. Public apps can't be granted this access scope.Returns an Article resource by ID.
List of the shop's articles.
List of all article tags.
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 the
access scope to be able to retrieve the 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.Returns an automatic discount resource by ID.
List of automatic discounts.
List of the shop's automatic discount saved searches.
Returns a list of activated carrier services and associated shop locations that support them.
A list of available locales.
Returns the Balance account information for finance embedded apps.
Returns a Blog resource by ID.
List of the shop's blogs.
Count of blogs.
Returns the number of bundle products that have been created by the current app.
Returns a list of Business Entities associated with the shop.
Returns a Business Entity by ID.
Returns a
object by ID.Retrieve a list of CarrierServices.
List of Cart transform objects owned by the current API client.
Lookup a cash tracking session by ID.
Returns a shop's cash tracking sessions for locations with a POS Pro subscription.
Tip: To query for cash tracking sessions in bulk, you can perform a bulk operation.
Returns a Catalog resource by ID.
Returns the most recent catalog operations for the shop.
The catalogs belonging to the shop.
The count of catalogs belonging to the shop. Limited to a maximum of 10000.
Returns the visual customizations for checkout for a given checkout profile.
To learn more about updating checkout branding settings, refer to the checkoutBrandingUpsert mutation and the checkout branding tutorial.
A checkout profile on a shop.
List of checkout profiles on a shop.
Returns a code discount resource by ID.
Returns a code discount identified by its discount code.
List of code discounts. Special fields for query params:
- status: active, expired, scheduled
- discount_type: bogo, fixed_amount, free_shipping, percentage.
List of the shop's code discount saved searches.
Returns a Collection resource by ID.
Return a collection by its handle.
Lists all rules that can be used to create smart collections.
Returns a list of collections.
Returns a list of the shop's collection saved searches.
Count of collections. Limited to a maximum of 10000.
Returns a Comment resource by ID.
List of the shop's comments.
Returns the list of companies in the shop.
The number of companies for a shop.
Returns a
Companyobject by ID.Returns a
object by ID.Returns a
object by ID.Returns a
object by ID.Returns the list of company locations in the shop.
Returns the customer privacy consent policies of a shop.
List of countries and regions for which consent policies can be created or updated.
Return the AppInstallation for the currently authenticated App.
Returns the current app's most recent BulkOperation. Apps can run one bulk query and one bulk mutation operation at a time, by shop.
The staff member making the API request.
Returns a Customer resource by ID.
Returns a customer account page.
List of the shop's customer account pages.
Returns the status of a customer merge request job.
Returns a preview of a customer merge request.
Returns a CustomerPaymentMethod resource by its ID.
Returns a list of customers.
The number of customers.
The list of members, such as customers, that's associated with an individual segment. The maximum page size is 1000.
Whether a member, which is a customer, belongs to a segment.
Returns a segment members query resource by ID.
The delivery customization.
The delivery customizations.
Returns a Delivery Profile resource by ID.
Returns a list of saved delivery profiles.
Lookup a delivery promise provider.
Represents the delivery promise settings for a shop.
A SKU setting for a delivery promise.
Returns the shop-wide shipping settings.
The total number of discount codes for the shop.
Returns a discount resource by ID.
List of discounts.
The total number of discounts for the shop. Limited to a maximum of 10000.
Returns a bulk code creation resource by ID.
List of the shop's redeemed discount code saved searches.
Returns the discount resource feedback for the currently authenticated app.
Returns dispute details based on ID.
Returns dispute evidence details based on ID.
All disputes related to the Shop.
Lookup a Domain by ID.
Returns a DraftOrder resource by ID.
Returns the number of draft orders that match the query.
List of saved draft orders.
List of the shop's draft order saved searches.
Returns a DraftOrderTag resource by ID.
Get a single event by its id.
The paginated list of events associated with the store.
Count of events. Limited to a maximum of 10000.
Returns a paginated list of files that have been uploaded to Shopify.
A list of the shop's file saved searches.
Returns the access policy for a finance app .
Returns the KYC information for the shop's Shopify Payments account, used in embedded finance apps.
Returns a Fulfillment resource by ID.
The fulfillment constraint rules that belong to a shop.
Returns a Fulfillment order resource by ID.
The paginated list of all fulfillment orders. The returned fulfillment orders are filtered according to the fulfillment order access scopes granted to the app.
Use this query to retrieve fulfillment orders assigned to merchant-managed locations, third-party fulfillment service locations, or all kinds of locations together.
For fetching only the fulfillment orders assigned to the app's locations, use the assignedFulfillmentOrders connection.
Returns a FulfillmentService resource by ID.
Fetch a gate configuration resource by ID.
List of the shop's gate configurations.
Returns a gift card resource by ID.
The configuration for the shop's gift cards.
Returns a list of gift cards.
The total number of gift cards issued for the shop. Limited to a maximum of 10000.
Returns an InventoryItem object by ID.
Returns a list of inventory items.
Returns an InventoryLevel object by ID.
General inventory properties for the shop.
Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.
Returns an inventory Location resource by ID.
Returns a list of active inventory locations.
Returns a list of all origin locations available for a delivery profile.
Returns the count of locations for the given shop. Limited to a maximum of 10000.
Returns a list of fulfillment orders that are on hold.
Returns a market resource by ID.
Returns the applicable market for a customer based on where they are in the world.
A list of marketing activities associated with the marketing app.
Returns a MarketingActivity resource by ID.
Returns a MarketingEvent resource by ID.
A list of marketing events associated with the marketing app.
A resource that can have localized values for different markets.
Resources that can have localized values for different markets.
Resources that can have localized values for different markets.
The markets configured for the shop.
Returns a Menu resource by ID.
The shop's menus.
Returns a metafield definition by identifier.
Returns a list of metafield definitions.
Each metafield definition has a type, which defines the type of information that it can store. This type is enforced across every instance of the resource that owns the metafield definition.
Refer to the list of supported metafield types.
A paginated list of metafields.
Retrieves a metaobject by ID.
Retrieves a metaobject by handle.
Retrieves a metaobject definition by ID.
Finds a metaobject definition by type.
All metaobject definitions.
All metaobjects for the shop.
Return a mobile platform application by its ID.
List the mobile platform applications.
Determine if a shop is eligibile to sell NFTs.
Returns a specific node (any object that implements the Node interface) by ID, in accordance with the Relay specification. This field is commonly used for refetching an object.
Returns the list of nodes (any objects that implement the Node interface) with the given IDs, in accordance with the Relay specification.
The shop's online store channel.
Returns an Order resource by ID.
Returns an Order editing session by order ID.
Returns a payment status by payment reference ID. Used to check the status of a deferred payment.
Returns a list of orders placed in the store.
List of the shop's order saved searches.
Returns the count of orders for the given shop. Limited to a maximum of 10000.
Returns a Page resource by ID.
List of the shop's pages.
Count of pages.
The payment customization.
The payment customizations.
The list of payment terms templates eligible for all shops and users.
The number of pendings orders. Limited to a maximum of 10000.
Events that impact storefront performance, measured via RUM (Real User Monitoring).
RUM (Real User Monitoring) performance metrics for a shop.
The set of features associated with a plan.
Returns a price list resource by ID.
All price lists for a shop.
The primary market of the shop.
Privacy related settings for a shop.
Returns a Product resource by ID.
Return a product by its handle.
Returns the product duplicate job.
Returns a ProductFeed resource by ID.
The product feeds for the shop.
Returns a ProductOperation resource by ID.
This can be used to query the ProductSetOperation, using the ID that was returned when the product was created or updated by the ProductSet mutation.
The
statusfield indicates whether the operation is,, or.The
productfield provides the details of the created or updated product.For the ProductSetOperation, the
field provides mutation errors that occurred during the operation.Returns the product resource feedback for the currently authenticated app.
Returns a list of products.
Returns a list of the shop's product saved searches.
Count of products. Limited to a maximum of 10000.
Returns a ProductVariant resource by ID.
Returns a list of product variants.
Count of product variants.
The list of publicly-accessible Admin API versions, including supported versions, the release candidate, and unstable versions.
Lookup a publication by ID.
List of publications.
Count of publications.
Returns a count of published products by publication ID.
Returns a Refund resource by ID.
Returns a Return resource by ID.
Lookup a returnable fulfillment by ID.
List of returnable fulfillments.
The calculated monetary value to be exchanged due to the return.
Lookup a reverse delivery by ID.
Lookup a reverse fulfillment order by ID.
Theme app extensions
Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.
Script tag deprecation
Script tags will be sunset for the Order status page on August 28, 2025. Upgrade to Checkout Extensibility before this date. Shopify Scripts will continue to work alongside Checkout Extensibility until August 28, 2025.
Lookup a script tag resource by ID.
Theme app extensions
Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.
Script tag deprecation
Script tags will be sunset for the Order status page on August 28, 2025. Upgrade to Checkout Extensibility before this date. Shopify Scripts will continue to work alongside Checkout Extensibility until August 28, 2025.
A list of script tags.
The Customer Segment.
A list of filters.
A list of filter suggestions associated with a segment. A segment is a group of members (commonly customers) that meet specific criteria.
A list of a shop's segment migrations.
A list of a shop's segments.
The number of segments for a shop.
The list of suggested values corresponding to a particular filter for a segment. A segment is a group of members, such as customers, that meet specific criteria.
Returns a Selling Plan Group resource by ID.
List Selling Plan Groups.
The server pixel configured by the app.
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.
The shop's billing preferences.
The Shopify Function.
Returns the Shopify Functions for apps installed on the shop.
Shopify Payments account information, including balances and payouts.
A list of locales available on a shop.
The StaffMember resource, by ID.
The shop staff members.
Standard metafield definitions are intended for specific, common use cases. Their namespace and keys reflect these use cases and are reserved.
Refer to all available
Standard Metafield Definition Templates.Returns a store credit account resource by ID.
Returns a SubscriptionBillingAttempt by ID.
Returns subscription billing attempts on a store.
Returns a subscription billing cycle found either by cycle index or date.
Retrieves the results of the asynchronous job for the subscription billing cycle bulk action based on the specified job ID. This query can be used to obtain the billing cycles that match the criteria defined in the subscriptionBillingCycleBulkSearch and subscriptionBillingCycleBulkCharge mutations.
Returns subscription billing cycles for a contract ID.
Returns a Subscription Contract resource by ID.
List Subscription Contracts.
Returns a Subscription Draft resource by ID.
Gateway used for subscription charges.
The Taxonomy resource lets you access the categories, attributes and values of the loaded taxonomy tree.
Returns a list of TenderTransactions associated with the shop.
Returns a particular theme for the shop.
Returns a paginated list of themes for the shop.
A resource that can have localized values for different languages.
Resources that can have localized values for different languages.
Resources that can have localized values for different languages.
Returns a redirect resource by ID.
Returns a redirect import resource by ID.
A list of redirects for a shop.
A list of the shop's URL redirect saved searches.
Count of redirects. Limited to a maximum of 10000.
Validation available on the shop.
Validations available on the shop.
Returns a webhook subscription by ID.
Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your
shopify.app.tomlmay be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.Returns a list of webhook subscriptions.
Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your
shopify.app.tomlmay be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.The count of webhook subscriptions.
Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your
shopify.app.tomlmay be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions. Limited to a maximum of 10000.The web pixel configured by the app.