QueryRoot
The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start.
Anchor to Fields and connectionsFields and connections
- Anchor to abandonmentabandonment•
Returns an abandonment by ID.
- Anchor to abandonmentByAbandonedCheckoutIdabandonment•
By Abandoned Checkout Id Returns an Abandonment by the Abandoned Checkout ID.
- •
Lookup an App by ID or return the currently authenticated App.
- Anchor to appByHandleapp•
By Handle Fetches app by handle. Returns null if the app doesn't exist.
- Anchor to appByKeyapp•
By Key Fetches an app by its client ID. Returns null if the app doesn't exist.
- Anchor to appDiscountTypeapp•
Discount Type An app discount type.
- Anchor to appDiscountTypesapp•
Discount Types [AppDiscount non-nullType!]! A list of app discount types installed by apps.
- Anchor to appInstallationapp•
Installation Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App.
- Anchor to appInstallationsapp•
Installations AppInstallation non-nullConnection! 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.
- Anchor to automaticDiscountNodeautomatic•
Discount Node Returns an automatic discount resource by ID.
- Anchor to automaticDiscountNodesautomatic•
Discount Nodes DiscountAutomatic non-nullNode Connection! Returns a list of automatic discounts.
- Anchor to automaticDiscountSavedSearchesautomatic•
Discount Saved Searches SavedSearch non-nullConnection! List of the shop's automatic discount saved searches.
- Anchor to availableCarrierServicesavailable•
Carrier Services Returns a list of activated carrier services and associated shop locations that support them.
- Anchor to availableLocalesavailable•
Locales [Locale!]!non-null A list of available locales.
- Anchor to carrierServicecarrier•
Service Returns a
object by ID.
- Anchor to cartTransformscart•
Transforms CartTransform non-nullConnection! List of Cart transform objects owned by the current API client.
- Anchor to cashTrackingSessioncash•
Tracking Session Lookup a cash tracking session by ID.
- Anchor to cashTrackingSessionscash•
Tracking Sessions CashTracking non-nullSession Connection! 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.
- Anchor to catalogcatalog•
Returns a Catalog resource by ID.
- Anchor to catalogOperationscatalog•
Operations [ResourceOperation!]! non-null Returns the most recent catalog operations for the shop.
- Anchor to catalogscatalogs•Catalog
Connection! non-null The catalogs belonging to the shop.
- Anchor to catalogsCountcatalogs•
Count The count of catalogs belonging to the shop. Limited to a maximum of 10000.
- Anchor to checkoutBrandingcheckout•
Branding 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.
- Anchor to checkoutProfilecheckout•
Profile A checkout profile on a shop.
- Anchor to checkoutProfilescheckout•
Profiles CheckoutProfile non-nullConnection! List of checkout profiles on a shop.
- Anchor to codeDiscountNodecode•
Discount Node Returns a code discount resource by ID.
- Anchor to codeDiscountNodeByCodecode•
Discount Node By Code Returns a code discount identified by its discount code.
- Anchor to codeDiscountNodescode•
Discount Nodes DiscountCode non-nullNode Connection! Returns a list of code-based discounts.
- Anchor to codeDiscountSavedSearchescode•
Discount Saved Searches SavedSearch non-nullConnection! List of the shop's code discount saved searches.
- Anchor to collectioncollection•
Returns a Collection resource by ID.
- Anchor to collectionRulesConditionscollection•
Rules Conditions [CollectionRule non-nullConditions!]! Lists all rules that can be used to create smart collections.
- Anchor to collectionscollections•Collection
Connection! non-null Returns a list of collections.
- Anchor to collectionSavedSearchescollection•
Saved Searches SavedSearch non-nullConnection! Returns a list of the shop's collection saved searches.
- Anchor to companiescompanies•Company
Connection! non-null Returns the list of companies in the shop.
- Anchor to companiesCountcompanies•
Count The number of companies for a shop.
- Anchor to companycompany•
Returns a
Company
object by ID.- Anchor to companyContactcompany•
Contact Returns a
object by ID.
- Anchor to companyContactRolecompany•
Contact Role Returns a
object by ID.
- Anchor to companyLocationcompany•
Location Returns a
object by ID.
- Anchor to companyLocationscompany•
Locations CompanyLocation non-nullConnection! Returns the list of company locations in the shop.
- Anchor to currentAppInstallationcurrent•
App Installation AppInstallation! non-null Return the AppInstallation for the currently authenticated App.
- Anchor to currentBulkOperationcurrent•
Bulk Operation Returns the current app's most recent BulkOperation. Apps can run one bulk query and one bulk mutation operation at a time, by shop.
- Anchor to customercustomer•
Returns a Customer resource by ID.
- Anchor to customerMergeJobStatuscustomer•
Merge Job Status Returns the status of a customer merge request job.
- Anchor to customerMergePreviewcustomer•
Merge Preview CustomerMerge non-nullPreview! Returns a preview of a customer merge request.
- Anchor to customerPaymentMethodcustomer•
Payment Method Returns a CustomerPaymentMethod resource by its ID.
- Anchor to customerscustomers•Customer
Connection! non-null Returns a list of customers.
- Anchor to customerSegmentMemberscustomer•
Segment Members CustomerSegment non-nullMember Connection! The list of members, such as customers, that's associated with an individual segment. The maximum page size is 1000.
- Anchor to customerSegmentMembershipcustomer•
Segment Membership SegmentMembership non-nullResponse! Whether a member, which is a customer, belongs to a segment.
- Anchor to customerSegmentMembersQuerycustomer•
Segment Members Query Returns a segment members query resource by ID.
- Anchor to deliveryCustomizationdelivery•
Customization The delivery customization.
- Anchor to deliveryCustomizationsdelivery•
Customizations DeliveryCustomization non-nullConnection! The delivery customizations.
- Anchor to deliveryProfiledelivery•
Profile Returns a Delivery Profile resource by ID.
- Anchor to deliveryProfilesdelivery•
Profiles DeliveryProfile non-nullConnection! Returns a list of saved delivery profiles.
- Anchor to deliverySettingsdelivery•
Settings Returns the shop-wide shipping settings.
- Anchor to discountCodesCountdiscount•
Codes Count The total number of discount codes for the shop.
- Anchor to discountNodediscount•
Node Returns a discount resource by ID.
- Anchor to discountNodesdiscount•
Nodes DiscountNode non-nullConnection! Returns a list of discounts.
- Anchor to discountRedeemCodeBulkCreationdiscount•
Redeem Code Bulk Creation Returns a bulk code creation resource by ID.
- Anchor to discountRedeemCodeSavedSearchesdiscount•
Redeem Code Saved Searches SavedSearch non-nullConnection! List of the shop's redeemed discount code saved searches.
- Anchor to disputedispute•
Returns dispute details based on ID.
- Anchor to disputeEvidencedispute•
Evidence Returns dispute evidence details based on ID.
- Anchor to domaindomain•
Lookup a Domain by ID.
- Anchor to draftOrderdraft•
Order Returns a DraftOrder resource by ID.
- Anchor to draftOrdersdraft•
Orders DraftOrder non-nullConnection! List of saved draft orders.
- Anchor to draftOrderSavedSearchesdraft•
Order Saved Searches SavedSearch non-nullConnection! List of the shop's draft order saved searches.
- Anchor to draftOrderTagdraft•
Order Tag Returns a DraftOrderTag resource by ID.
- Anchor to filesfiles•File
Connection! non-null Returns a paginated list of files that have been uploaded to Shopify.
- Anchor to fileSavedSearchesfile•
Saved Searches SavedSearch non-nullConnection! A list of the shop's file saved searches.
- Anchor to fulfillmentfulfillment•
Returns a Fulfillment resource by ID.
- Anchor to fulfillmentConstraintRulesfulfillment•
Constraint Rules [FulfillmentConstraint non-nullRule!]! The fulfillment constraint rules that belong to a shop.
- Anchor to fulfillmentOrderfulfillment•
Order Returns a Fulfillment order resource by ID.
- Anchor to fulfillmentOrdersfulfillment•
Orders FulfillmentOrder non-nullConnection! 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.
- Anchor to fulfillmentServicefulfillment•
Service Returns a FulfillmentService resource by ID.
- Anchor to giftCardgift•
Card Returns a gift card resource by ID.
- Anchor to giftCardsgift•
Cards GiftCard non-nullConnection! Returns a list of gift cards.
- Anchor to giftCardsCountgift•
Cards Count The total number of gift cards issued for the shop. Limited to a maximum of 10000.
- Anchor to inventoryIteminventory•
Item Returns an InventoryItem object by ID.
- Anchor to inventoryItemsinventory•
Items InventoryItem non-nullConnection! Returns a list of inventory items.
- Anchor to inventoryLevelinventory•
Level Returns an InventoryLevel object by ID.
- Anchor to inventoryPropertiesinventory•
Properties InventoryProperties! non-null General inventory properties for the shop.
- •
Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.
- Anchor to locationlocation•
Returns an inventory Location resource by ID.
- Anchor to locationslocations•Location
Connection! non-null Returns a list of active inventory locations.
- Anchor to locationsAvailableForDeliveryProfilesConnectionlocations•
Available For Delivery Profiles Connection LocationConnection! non-null Returns a list of all origin locations available for a delivery profile.
- Anchor to manualHoldsFulfillmentOrdersmanual•
Holds Fulfillment Orders FulfillmentOrder non-nullConnection! Returns a list of fulfillment orders that are on hold.
- Anchor to marketmarket•
Returns a market resource by ID.
- Anchor to marketByGeographymarket•
By Geography Returns the applicable market for a customer based on where they are in the world.
- Anchor to marketingActivitiesmarketing•
Activities MarketingActivity non-nullConnection! A list of marketing activities associated with the marketing app.
- Anchor to marketingActivitymarketing•
Activity Returns a MarketingActivity resource by ID.
- Anchor to marketingEventmarketing•
Event Returns a MarketingEvent resource by ID.
- Anchor to marketingEventsmarketing•
Events MarketingEvent non-nullConnection! A list of marketing events associated with the marketing app.
- Anchor to marketLocalizableResourcemarket•
Localizable Resource A resource that can have localized values for different markets.
- Anchor to marketLocalizableResourcesmarket•
Localizable Resources Resources that can have localized values for different markets.
- Anchor to marketLocalizableResourcesByIdsmarket•
Localizable Resources By Ids Resources that can have localized values for different markets.
- Anchor to marketsmarkets•Market
Connection! non-null The markets configured for the shop.
- Anchor to metafieldDefinitionmetafield•
Definition Returns a metafield definition by identifier.
- Anchor to metafieldDefinitionsmetafield•
Definitions MetafieldDefinition non-nullConnection! Returns a list of metafield definitions.
- Anchor to metafieldDefinitionTypesmetafield•
Definition Types [MetafieldDefinition non-nullType!]! 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.
- Anchor to metaobjectmetaobject•
Retrieves a metaobject by ID.
- Anchor to metaobjectByHandlemetaobject•
By Handle Retrieves a metaobject by handle.
- Anchor to metaobjectDefinitionmetaobject•
Definition Retrieves a metaobject definition by ID.
- Anchor to metaobjectDefinitionByTypemetaobject•
Definition By Type Finds a metaobject definition by type.
- Anchor to metaobjectDefinitionsmetaobject•
Definitions MetaobjectDefinition non-nullConnection! All metaobject definitions.
- Anchor to metaobjectsmetaobjects•Metaobject
Connection! non-null All metaobjects for the shop.
- Anchor to nodenode•
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.
- Anchor to nodesnodes•[Node]!non-null
Returns the list of nodes (any objects that implement the Node interface) with the given IDs, in accordance with the Relay specification.
- Anchor to orderorder•
Returns an Order resource by ID.
- Anchor to orderPaymentStatusorder•
Payment Status Returns a payment status by payment reference ID. Used to check the status of a deferred payment.
- Anchor to ordersorders•Order
Connection! non-null Returns a list of orders placed in the store.
- Anchor to orderSavedSearchesorder•
Saved Searches SavedSearch non-nullConnection! List of the shop's order saved searches.
- Anchor to paymentCustomizationpayment•
Customization The payment customization.
- Anchor to paymentCustomizationspayment•
Customizations PaymentCustomization non-nullConnection! The payment customizations.
- Anchor to paymentTermsTemplatespayment•
Terms Templates [PaymentTerms non-nullTemplate!]! The list of payment terms templates eligible for all shops and users.
- Anchor to pendingOrdersCountpending•
Orders Count The number of pendings orders. Limited to a maximum of 10000.
- Anchor to priceListprice•
List Returns a price list resource by ID.
- Anchor to priceListsprice•
Lists PriceList non-nullConnection! All price lists for a shop.
- Anchor to priceRuleSavedSearchesprice•
Rule Saved Searches SavedSearch non-nullConnection! List of the shop's price rule saved searches.
- Anchor to productproduct•
Returns a Product resource by ID.
- Anchor to productDuplicateJobproduct•
Duplicate Job ProductDuplicate non-nullJob! Returns the product duplicate job.
- Anchor to productFeedproduct•
Feed Returns a ProductFeed resource by ID.
- Anchor to productFeedsproduct•
Feeds ProductFeed non-nullConnection! The product feeds for the shop.
- Anchor to productOperationproduct•
Operation 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
status
field indicates whether the operation is,
, or
.
The
product
field provides the details of the created or updated product.For the ProductSetOperation, the
field provides mutation errors that occurred during the operation.
- Anchor to productResourceFeedbackproduct•
Resource Feedback Returns the product resource feedback for the currently authenticated app.
- Anchor to productsproducts•Product
Connection! non-null Returns a list of products.
- Anchor to productSavedSearchesproduct•
Saved Searches SavedSearch non-nullConnection! Returns a list of the shop's product saved searches.
- Anchor to productsCountproducts•
Count Count of products.
- Anchor to productVariantproduct•
Variant Returns a ProductVariant resource by ID.
- Anchor to productVariantsproduct•
Variants ProductVariant non-nullConnection! Returns a list of product variants.
- Anchor to publicApiVersionspublic•
Api Versions [ApiVersion!]! non-null The list of publicly-accessible Admin API versions, including supported versions, the release candidate, and unstable versions.
- Anchor to publicationpublication•
Lookup a publication by ID.
- Anchor to publicationspublications•Publication
Connection! non-null List of publications.
- Anchor to publicationsCountpublications•
Count Count of publications.
- Anchor to refundrefund•
Returns a Refund resource by ID.
- Anchor to returnreturn•
Returns a Return resource by ID.
- Anchor to returnableFulfillmentreturnable•
Fulfillment Lookup a returnable fulfillment by ID.
- Anchor to returnableFulfillmentsreturnable•
Fulfillments ReturnableFulfillment non-nullConnection! List of returnable fulfillments.
- Anchor to reverseDeliveryreverse•
Delivery Lookup a reverse delivery by ID.
- Anchor to reverseFulfillmentOrderreverse•
Fulfillment Order Lookup a reverse fulfillment order by ID.
- Anchor to scriptTagscript•
Tag 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.
- Anchor to scriptTagsscript•
Tags ScriptTag non-nullConnection! 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.
- Anchor to segmentsegment•
The Customer Segment.
- Anchor to segmentFilterssegment•
Filters SegmentFilter non-nullConnection! A list of filters.
- Anchor to segmentFilterSuggestionssegment•
Filter Suggestions SegmentFilter non-nullConnection! A list of filter suggestions associated with a segment. A segment is a group of members (commonly customers) that meet specific criteria.
- Anchor to segmentMigrationssegment•
Migrations SegmentMigration non-nullConnection! A list of a shop's segment migrations.
- Anchor to segmentssegments•Segment
Connection! non-null A list of a shop's segments.
- Anchor to segmentsCountsegments•
Count The number of segments for a shop.
- Anchor to segmentValueSuggestionssegment•
Value Suggestions SegmentValue non-nullConnection! 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.
- Anchor to sellingPlanGroupselling•
Plan Group Returns a Selling Plan Group resource by ID.
- Anchor to sellingPlanGroupsselling•
Plan Groups SellingPlan non-nullGroup Connection! List Selling Plan Groups.
- Anchor to serverPixelserver•
Pixel The server pixel configured by the app.
- Anchor to shopshop•Shop!non-null
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 shopBillingPreferencesshop•
Billing Preferences ShopBilling non-nullPreferences! The shop's billing preferences.
- Anchor to shopifyFunctionshopify•
Function Returns a Shopify Function by its ID. Functions enable you to customize Shopify's backend logic at defined parts of the commerce loop.
- Anchor to shopifyFunctionsshopify•
Functions ShopifyFunction non-nullConnection! Returns the Shopify Functions owned by the querying API client installed on the shop.
- Anchor to shopifyPaymentsAccountshopify•
Payments Account Shopify Payments account information, including balances and payouts.
- Anchor to shopifyqlQueryshopifyql•
Query Returns the results of a ShopifyQL query. Refer to the ShopifyQL documentation for more information.
- Anchor to shopLocalesshop•
Locales [ShopLocale!]! non-null A list of locales available on a shop.
- Anchor to staffMemberstaff•
Member The StaffMember resource, by ID.
- Anchor to standardMetafieldDefinitionTemplatesstandard•
Metafield Definition Templates 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
.- Anchor to subscriptionBillingAttemptsubscription•
Billing Attempt Returns a SubscriptionBillingAttempt by ID.
- Anchor to subscriptionBillingAttemptssubscription•
Billing Attempts Returns subscription billing attempts on a store.
- Anchor to subscriptionBillingCyclesubscription•
Billing Cycle Returns a subscription billing cycle found either by cycle index or date.
- Anchor to subscriptionBillingCyclessubscription•
Billing Cycles Returns subscription billing cycles for a contract ID.
- Anchor to subscriptionContractsubscription•
Contract Returns a Subscription Contract resource by ID.
- Anchor to subscriptionContractssubscription•
Contracts SubscriptionContract non-nullConnection! List Subscription Contracts.
- Anchor to subscriptionDraftsubscription•
Draft Returns a Subscription Draft resource by ID.
- Anchor to taxonomytaxonomy•
The Taxonomy resource lets you access the categories, attributes and values of the loaded taxonomy tree.
- Anchor to tenderTransactionstender•
Transactions TenderTransaction non-nullConnection! Returns a list of TenderTransactions associated with the shop.
- Anchor to translatableResourcetranslatable•
Resource A resource that can have localized values for different languages.
- Anchor to translatableResourcestranslatable•
Resources TranslatableResource non-nullConnection! Resources that can have localized values for different languages.
- Anchor to translatableResourcesByIdstranslatable•
Resources By Ids TranslatableResource non-nullConnection! Resources that can have localized values for different languages.
- Anchor to urlRedirecturl•
Redirect Returns a redirect resource by ID.
- Anchor to urlRedirectImporturl•
Redirect Import Returns a redirect import resource by ID.
- Anchor to urlRedirectsurl•
Redirects UrlRedirect non-nullConnection! A list of redirects for a shop.
- Anchor to urlRedirectSavedSearchesurl•
Redirect Saved Searches SavedSearch non-nullConnection! A list of the shop's URL redirect saved searches.
- Anchor to validationvalidation•
Validation available on the shop.
- Anchor to validationsvalidations•Validation
Connection! non-null Validations available on the shop.
- Anchor to webhookSubscriptionwebhook•
Subscription 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.toml
may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.- Anchor to webhookSubscriptionswebhook•
Subscriptions WebhookSubscription non-nullConnection! 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.toml
may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.- Anchor to webPixelweb•
Pixel Returns a web pixel by ID.