Choose a version:

QueryRoot

object

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 abandonedCheckoutsabandonedCheckouts •AbandonedCheckoutConnection! non-null: List of abandoned checkouts. Includes checkouts that were recovered after being abandoned.
Anchor to abandonedCheckoutsCountabandonedCheckoutsCount •Count: Returns the count of abandoned checkouts for the given shop. Limited to a maximum of 10000 by default.
Anchor to abandonmentabandonment •Abandonment: Returns an abandonment by ID.
Anchor to abandonmentByAbandonedCheckoutIdabandonmentByAbandonedCheckoutId •Abandonment: Returns an Abandonment by the Abandoned Checkout ID.
Anchor to appapp •App: Lookup an App by ID or return the currently authenticated App.
Anchor to appByHandleappByHandle •App: Fetches app by handle. Returns null if the app doesn't exist.
Anchor to appByKeyappByKey •App: Fetches an app by its client ID. Returns null if the app doesn't exist.
Anchor to appCreditsappCredits •AppCreditConnection! non-null: Credits that can be used towards future app purchases.
Anchor to appDiscountTypeappDiscountType •AppDiscountType: An app discount type.
Anchor to appDiscountTypesappDiscountTypes •[AppDiscountType!]! non-null: A list of app discount types installed by apps.
Anchor to appDiscountTypesNodesappDiscountTypesNodes •AppDiscountTypeConnection! non-null: A list of app discount types installed by apps.
Anchor to appInstallationappInstallation •AppInstallation: Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App.
Anchor to appInstallationsappInstallations •AppInstallationConnection! non-null: A list of app installations. To use this query, you need to contact Shopify Support to grant your custom app the read_apps access scope. Public apps can't be granted this access scope.
Anchor to articlearticle •Article: Returns an Article resource by ID.
Anchor to articleAuthorsarticleAuthors •ArticleAuthorConnection! non-null: List of article authors for the shop.
Anchor to articlesarticles •ArticleConnection! non-null: List of the shop's articles.
Anchor to articleTagsarticleTags •[String!]! non-null: List of all article tags.
Anchor to assignedFulfillmentOrdersassignedFulfillmentOrders •FulfillmentOrderConnection! 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 the read_assigned_fulfillment_orders access scope to be able to retrieve the fulfillment orders assigned to its locations.

All assigned fulfillment orders (except those with the CLOSED status) will be returned by default. Perform filtering with the assignmentStatus argument to receive only fulfillment orders that have been requested to be fulfilled.
Anchor to automaticDiscountNodeautomaticDiscountNode •DiscountAutomaticNode: Returns an automatic discount resource by ID.
Anchor to automaticDiscountNodesautomaticDiscountNodes •DiscountAutomaticNodeConnection! non-null: Returns a list of automatic discounts.
Anchor to automaticDiscountSavedSearchesautomaticDiscountSavedSearches •SavedSearchConnection! non-null: List of the shop's automatic discount saved searches.
Anchor to availableBackupRegionsavailableBackupRegions •[MarketRegion!]! non-null: The regions that can be used as the backup region of the shop.
Anchor to availableCarrierServicesavailableCarrierServices •[DeliveryCarrierServiceAndLocations!]! non-null: Returns a list of activated carrier services and associated shop locations that support them.
Anchor to availableLocalesavailableLocales •[Locale!]! non-null: A list of available locales.
Anchor to backupRegionbackupRegion •MarketRegion! non-null: The backup region of the shop.
Anchor to balanceAccountbalanceAccount •BalanceAccount: Returns the Balance account information for finance embedded apps.
Anchor to blogblog •Blog: Returns a Blog resource by ID.
Anchor to blogsblogs •BlogConnection! non-null: List of the shop's blogs.
Anchor to blogsCountblogsCount •Count: Count of blogs. Limited to a maximum of 10000 by default.
Anchor to bundleCountbundleCount •Int! non-null: Returns the number of bundle products that have been created by the current app.
Anchor to businessEntitiesbusinessEntities •[BusinessEntity!]! non-null: Returns a list of Business Entities associated with the shop.
Anchor to businessEntitybusinessEntity •BusinessEntity: Returns a Business Entity by ID.
Anchor to carrierServicecarrierService •DeliveryCarrierService: Returns a DeliveryCarrierService object by ID.
Anchor to carrierServicescarrierServices •DeliveryCarrierServiceConnection! non-null: Retrieve a list of CarrierServices.
Anchor to cartTransformscartTransforms •CartTransformConnection! non-null: List of Cart transform objects owned by the current API client.
Anchor to cashTrackingSessioncashTrackingSession •CashTrackingSession: Lookup a cash tracking session by ID.
Anchor to cashTrackingSessionscashTrackingSessions •CashTrackingSessionConnection! non-null: 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 •Catalog: Returns a Catalog resource by ID.
Anchor to catalogOperationscatalogOperations •[ResourceOperation!]! non-null: Returns the most recent catalog operations for the shop.
Anchor to catalogsCountcatalogsCount •Count: The count of catalogs belonging to the shop. Limited to a maximum of 10000 by default.
Anchor to checkoutBrandingcheckoutBranding •CheckoutBranding: 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 checkoutProfilecheckoutProfile •CheckoutProfile: A checkout profile on a shop.
Anchor to checkoutProfilescheckoutProfiles •CheckoutProfileConnection! non-null: List of checkout profiles on a shop.
Anchor to codeDiscountNodecodeDiscountNode •DiscountCodeNode: Returns a code discount resource by ID.
Anchor to codeDiscountNodeByCodecodeDiscountNodeByCode •DiscountCodeNode: Returns a code discount identified by its discount code.
Anchor to codeDiscountNodescodeDiscountNodes •DiscountCodeNodeConnection! non-null: Returns a list of code-based discounts.
Anchor to codeDiscountSavedSearchescodeDiscountSavedSearches •SavedSearchConnection! non-null: List of the shop's code discount saved searches.
Anchor to collectioncollection •Collection: Returns a Collection resource by ID.
Anchor to collectionByIdentifiercollectionByIdentifier •Collection: Return a collection by an identifier.
Anchor to collectionRulesConditionscollectionRulesConditions •[CollectionRuleConditions!]! non-null: Lists all rules that can be used to create smart collections.
Anchor to collectionscollections •CollectionConnection! non-null: Retrieves a list of collections in a store. Collections are groups of products that merchants can organize for display in their online store and other sales channels. For example, an athletics store might create different collections for running attire, shoes, and accessories.

Use the collections query when you need to:

Build a browsing interface for a store's product groupings.

Create collection searching, sorting, and filtering experiences (for example, by title, type, or published status).

Sync collection data with external systems.

Manage both custom (manual) and smart (automated) collections.

The collections query supports pagination for large catalogs and saved searches for frequently used collection queries.

The collections query returns collections with their associated metadata, including:

Basic collection information (title, description, handle, and type)

Collection image and SEO metadata

Product count and product relationships

Collection rules (for smart collections)

Publishing status and publication details

Metafields and custom attributes

Learn more about using metafields with smart collections.
Anchor to collectionSavedSearchescollectionSavedSearches •SavedSearchConnection! non-null: Returns a list of the shop's collection saved searches.
Anchor to collectionsCountcollectionsCount •Count: Count of collections. Limited to a maximum of 10000 by default.
Anchor to commentcomment •Comment: Returns a Comment resource by ID.
Anchor to commentscomments •CommentConnection! non-null: List of the shop's comments.
Anchor to companiescompanies •CompanyConnection! non-null: Returns the list of companies in the shop.
Anchor to companiesCountcompaniesCount •Count: The number of companies for a shop. Limited to a maximum of 10000 by default.
Anchor to companycompany •Company: Returns a Company object by ID.
Anchor to companyContactcompanyContact •CompanyContact: Returns a CompanyContact object by ID.
Anchor to companyContactRolecompanyContactRole •CompanyContactRole: Returns a CompanyContactRole object by ID.
Anchor to companyLocationcompanyLocation •CompanyLocation: Returns a CompanyLocation object by ID.
Anchor to companyLocationscompanyLocations •CompanyLocationConnection! non-null: Returns the list of company locations in the shop.
Anchor to consentPolicyconsentPolicy •[ConsentPolicy!]! non-null: Returns the customer privacy consent policies of a shop.
Anchor to consentPolicyRegionsconsentPolicyRegions •[ConsentPolicyRegion!]! non-null: List of countries and regions for which consent policies can be created or updated.
Anchor to currentAppInstallationcurrentAppInstallation •AppInstallation! non-null: Return the AppInstallation for the currently authenticated App.
Anchor to currentBulkOperationcurrentBulkOperation •BulkOperation: 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 currentStaffMembercurrentStaffMember •StaffMember: The staff member making the API request.
Anchor to customercustomer •Customer: Returns a Customer resource by ID.
Anchor to customerAccountPagecustomerAccountPage •CustomerAccountPage: Returns a customer account page.
Anchor to customerByIdentifiercustomerByIdentifier •Customer: Return a customer by an identifier.
Anchor to customerMergeJobStatuscustomerMergeJobStatus •CustomerMergeRequest: Returns the status of a customer merge request job.
Anchor to customerMergePreviewcustomerMergePreview •CustomerMergePreview! non-null: Returns a preview of a customer merge request.
Anchor to customerPaymentMethodcustomerPaymentMethod •CustomerPaymentMethod: Returns a CustomerPaymentMethod resource by its ID.
Anchor to customerscustomers •CustomerConnection! non-null: Returns a list of customers in your Shopify store, including key information such as name, email, location, and purchase history. Use this query to segment your audience, personalize marketing campaigns, or analyze customer behavior by applying filters based on location, order history, marketing preferences and tags. The customers query supports pagination and sorting.
Anchor to customerSavedSearchescustomerSavedSearches •SavedSearchConnection! non-null: List of the shop's customer saved searches.
Anchor to customersCountcustomersCount •Count: The number of customers. Limited to a maximum of 10000 by default.
Anchor to customerSegmentMemberscustomerSegmentMembers •CustomerSegmentMemberConnection! non-null: The list of members, such as customers, that's associated with an individual segment. The maximum page size is 1000.
Anchor to customerSegmentMembersCountcustomerSegmentMembersCount •Count: The count of customers in a segment.
Anchor to customerSegmentMembershipcustomerSegmentMembership •SegmentMembershipResponse! non-null: Whether a member, which is a customer, belongs to a segment.
Anchor to customerSegmentMembersQuerycustomerSegmentMembersQuery •CustomerSegmentMembersQuery: Returns a segment members query resource by ID.
Anchor to deliveryCustomizationdeliveryCustomization •DeliveryCustomization: The delivery customization.
Anchor to deliveryCustomizationsdeliveryCustomizations •DeliveryCustomizationConnection! non-null: The delivery customizations.
Anchor to deliveryProfiledeliveryProfile •DeliveryProfile: Returns a Delivery Profile resource by ID.
Anchor to deliveryProfilesdeliveryProfiles •DeliveryProfileConnection! non-null: Returns a list of saved delivery profiles.
Anchor to deliveryPromiseParticipantsdeliveryPromiseParticipants •DeliveryPromiseParticipantConnection: Returns delivery promise participants.
Anchor to deliveryPromiseProviderdeliveryPromiseProvider •DeliveryPromiseProvider: Lookup a delivery promise provider.
Anchor to deliveryPromiseSettingsdeliveryPromiseSettings •DeliveryPromiseSetting! non-null: Represents the delivery promise settings for a shop.
Anchor to deliveryPromiseSkuSettingdeliveryPromiseSkuSetting •DeliveryPromiseSkuSetting: A SKU setting for a delivery promise.
Anchor to deliverySettingsdeliverySettings •DeliverySetting: Returns the shop-wide shipping settings.
Anchor to discountCodesCountdiscountCodesCount •Count: The total number of discount codes for the shop. Limited to a maximum of 10000 by default.
Anchor to discountNodediscountNode •DiscountNode: Returns a discount resource by ID.
Anchor to discountNodesdiscountNodes •DiscountNodeConnection! non-null: Returns a list of discounts.
Anchor to discountNodesCountdiscountNodesCount •Count: The total number of discounts for the shop. Limited to a maximum of 10000 by default.
Anchor to discountRedeemCodeBulkCreationdiscountRedeemCodeBulkCreation •DiscountRedeemCodeBulkCreation: Returns a bulk code creation resource by ID.
Anchor to discountRedeemCodeSavedSearchesdiscountRedeemCodeSavedSearches •SavedSearchConnection! non-null: List of the shop's redeemed discount code saved searches.
Anchor to discountResourceFeedbackdiscountResourceFeedback •DiscountResourceFeedback: Returns the discount resource feedback for the currently authenticated app.
Anchor to disputedispute •ShopifyPaymentsDispute: Returns dispute details based on ID.
Anchor to disputeEvidencedisputeEvidence •ShopifyPaymentsDisputeEvidence: Returns dispute evidence details based on ID.
Anchor to disputesdisputes •ShopifyPaymentsDisputeConnection! non-null: All disputes related to the Shop.
Anchor to domaindomain •Domain: Lookup a Domain by ID.
Anchor to draftOrderdraftOrder •DraftOrder: Returns a DraftOrder resource by ID.
Anchor to draftOrderAvailableDeliveryOptionsdraftOrderAvailableDeliveryOptions •DraftOrderAvailableDeliveryOptions! non-null: Returns a list of available delivery options for a draft order.
Anchor to draftOrdersdraftOrders •DraftOrderConnection! non-null: List of saved draft orders.
Anchor to draftOrderSavedSearchesdraftOrderSavedSearches •SavedSearchConnection! non-null: List of the shop's draft order saved searches.
Anchor to draftOrdersCountdraftOrdersCount •Count: Returns the number of draft orders that match the query. Limited to a maximum of 10000 by default.
Anchor to draftOrderTagdraftOrderTag •DraftOrderTag: Returns a DraftOrderTag resource by ID.
Anchor to eventevent •Event: Get a single event by its id.
Anchor to eventsCounteventsCount •Count: Count of events. Limited to a maximum of 10000.
Anchor to fileSavedSearchesfileSavedSearches •SavedSearchConnection! non-null: A list of the shop's file saved searches.
Anchor to financeAppAccessPolicyfinanceAppAccessPolicy •FinanceAppAccessPolicy! non-null: Returns the access policy for a finance app .
Anchor to financeKycInformationfinanceKycInformation •FinanceKycInformation: Returns the KYC information for the shop's Shopify Payments account, used in embedded finance apps.
Anchor to fulfillmentfulfillment •Fulfillment: Returns a Fulfillment resource by ID.
Anchor to fulfillmentConstraintRulesfulfillmentConstraintRules •[FulfillmentConstraintRule!]! non-null: The fulfillment constraint rules that belong to a shop.
Anchor to fulfillmentOrderfulfillmentOrder •FulfillmentOrder: Returns a Fulfillment order resource by ID.
Anchor to fulfillmentOrdersfulfillmentOrders •FulfillmentOrderConnection! non-null: 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 fulfillmentServicefulfillmentService •FulfillmentService: Returns a FulfillmentService resource by ID.
Anchor to giftCardgiftCard •GiftCard: Returns a gift card resource by ID.
Anchor to giftCardConfigurationgiftCardConfiguration •GiftCardConfiguration! non-null: The configuration for the shop's gift cards.
Anchor to giftCardsgiftCards •GiftCardConnection! non-null: Returns a list of gift cards.
Anchor to giftCardsCountgiftCardsCount •Count: The total number of gift cards issued for the shop. Limited to a maximum of 10000 by default.
Anchor to inventoryIteminventoryItem •InventoryItem: Returns an InventoryItem object by ID.
Anchor to inventoryItemsinventoryItems •InventoryItemConnection! non-null: Returns a list of inventory items.
Anchor to inventoryLevelinventoryLevel •InventoryLevel: Returns an InventoryLevel object by ID.
Anchor to inventoryPropertiesinventoryProperties •InventoryProperties! non-null: General inventory properties for the shop.
Anchor to inventoryShipmentinventoryShipment •InventoryShipment: Returns an inventory shipment by ID.
Anchor to inventoryTransferinventoryTransfer •InventoryTransfer: Returns an inventory transfer by ID.
Anchor to inventoryTransfersinventoryTransfers •InventoryTransferConnection! non-null: Returns a paginated list of transfers.
Anchor to jobjob •Job: Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.
Anchor to locationlocation •Location: Returns an inventory Location resource by ID.
Anchor to locationByIdentifierlocationByIdentifier •Location: Return a location by an identifier.
Anchor to locationslocations •LocationConnection! non-null: Returns a list of active inventory locations.
Anchor to locationsAvailableForDeliveryProfilesConnectionlocationsAvailableForDeliveryProfilesConnection •LocationConnection! non-null: Returns a list of all origin locations available for a delivery profile.
Anchor to locationsCountlocationsCount •Count: Returns the count of locations for the given shop. Limited to a maximum of 10000 by default.
Anchor to manualHoldsFulfillmentOrdersmanualHoldsFulfillmentOrders •FulfillmentOrderConnection! non-null: Returns a list of fulfillment orders that are on hold.
Anchor to marketmarket •Market: Returns a market resource by ID.
Anchor to marketingActivitiesmarketingActivities •MarketingActivityConnection! non-null: A list of marketing activities associated with the marketing app.
Anchor to marketingActivitymarketingActivity •MarketingActivity: Returns a MarketingActivity resource by ID.
Anchor to marketingEventmarketingEvent •MarketingEvent: Returns a MarketingEvent resource by ID.
Anchor to marketingEventsmarketingEvents •MarketingEventConnection! non-null: A list of marketing events associated with the marketing app.
Anchor to marketLocalizableResourcemarketLocalizableResource •MarketLocalizableResource: A resource that can have localized values for different markets.
Anchor to marketLocalizableResourcesmarketLocalizableResources •MarketLocalizableResourceConnection! non-null: Resources that can have localized values for different markets.
Anchor to marketLocalizableResourcesByIdsmarketLocalizableResourcesByIds •MarketLocalizableResourceConnection! non-null: Resources that can have localized values for different markets.
Anchor to marketsmarkets •MarketConnection! non-null: The markets configured for the shop.
Anchor to marketsResolvedValuesmarketsResolvedValues •MarketsResolvedValues! non-null: The resolved values for a buyer signal.
Anchor to menumenu •Menu: Returns a Menu resource by ID.
Anchor to menusmenus •MenuConnection! non-null: The shop's menus.
Anchor to metafieldDefinitionmetafieldDefinition •MetafieldDefinition: Returns a metafield definition by identifier.
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-null: Returns a list of metafield definitions.
Anchor to metafieldDefinitionTypesmetafieldDefinitionTypes •[MetafieldDefinitionType!]! non-null: 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 metafieldsmetafields •MetafieldConnection! non-null: A paginated list of metafields.
Anchor to metaobjectmetaobject •Metaobject: Retrieves a metaobject by ID.
Anchor to metaobjectByHandlemetaobjectByHandle •Metaobject: Retrieves a metaobject by handle.
Anchor to metaobjectDefinitionmetaobjectDefinition •MetaobjectDefinition: Retrieves a metaobject definition by ID.
Anchor to metaobjectDefinitionByTypemetaobjectDefinitionByType •MetaobjectDefinition: Finds a metaobject definition by type.
Anchor to metaobjectDefinitionsmetaobjectDefinitions •MetaobjectDefinitionConnection! non-null: All metaobject definitions.
Anchor to metaobjectsmetaobjects •MetaobjectConnection! non-null: All metaobjects for the shop.
Anchor to mobilePlatformApplicationmobilePlatformApplication •MobilePlatformApplication: Return a mobile platform application by its ID.
Anchor to mobilePlatformApplicationsmobilePlatformApplications •MobilePlatformApplicationConnection! non-null: List the mobile platform applications.
Anchor to nftSalesEligibilitynftSalesEligibility •NftSalesEligibilityResult! non-null: Determine if a shop is eligibile to sell NFTs.
Anchor to nodenode •Node: 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 onlineStoreonlineStore •OnlineStore! non-null: The shop's online store channel.
Anchor to orderorder •Order: The order query retrieves an order by its ID. This query provides access to comprehensive order information such as customer details, line items, financial data, and fulfillment status.

Use the order query to retrieve information associated with the following processes:

Order management and fulfillment

Financial reporting

Customer purchase history and transaction analysis

Shipping and inventory management

You can only retrieve the last 60 days worth of orders from a store by default. If you want to access older orders, then you need to request access to all orders.

For large order datasets, consider using bulk operations. Bulk operations handle pagination automatically and allow you to retrieve data asynchronously without being constrained by API rate limits. Learn more about creating orders and building order management apps.
Anchor to orderByIdentifierorderByIdentifier •Order: Return an order by an identifier.
Anchor to orderEditSessionorderEditSession •OrderEditSession: Returns an Order editing session by order ID.
Anchor to orderPaymentStatusorderPaymentStatus •OrderPaymentStatus: Returns a payment status by payment reference ID. Used to check the status of a deferred payment.
Anchor to ordersorders •OrderConnection! non-null: Returns a list of orders placed in the store, including data such as order status, customer, and line item details. Use the orders query to build reports, analyze sales performance, or automate fulfillment workflows. The orders query supports pagination, sorting, and filtering.
Anchor to orderSavedSearchesorderSavedSearches •SavedSearchConnection! non-null: List of the shop's order saved searches.
Anchor to ordersCountordersCount •Count: Returns the count of orders for the given shop. Limited to a maximum of 10000 by default.
Anchor to pagepage •Page: Returns a Page resource by ID.
Anchor to pagespages •PageConnection! non-null: List of the shop's pages.
Anchor to pagesCountpagesCount •Count: Count of pages. Limited to a maximum of 10000 by default.
Anchor to paymentCustomizationpaymentCustomization •PaymentCustomization: The payment customization.
Anchor to paymentCustomizationspaymentCustomizations •PaymentCustomizationConnection! non-null: The payment customizations.
Anchor to paymentTermsTemplatespaymentTermsTemplates •[PaymentTermsTemplate!]! non-null: The list of payment terms templates eligible for all shops and users.
Anchor to pendingOrdersCountpendingOrdersCount •Count: The number of pendings orders. Limited to a maximum of 10000.
Anchor to performanceEventsperformanceEvents •[PerformanceEvent!]: Events that impact storefront performance, measured via RUM (Real User Monitoring).
Anchor to performanceMetricsperformanceMetrics •[PerformanceMetrics!]: RUM (Real User Monitoring) performance metrics for a shop.
Anchor to pointOfSaleDevicepointOfSaleDevice •PointOfSaleDevice: Lookup a point of sale device by ID.
Anchor to priceListpriceList •PriceList: Returns a price list resource by ID.
Anchor to priceListspriceLists •PriceListConnection! non-null: All price lists for a shop.
Anchor to privacySettingsprivacySettings •PrivacySettings! non-null: Privacy related settings for a shop.
Anchor to productproduct •Product: Retrieves a product by its ID. A product is an item that a merchant can sell in their store.

Use the product query when you need to:

Access essential product data (for example, title, description, price, images, SEO metadata, and metafields).

Build product detail pages and manage inventory.

Handle international sales with localized pricing and content.

Manage product variants and product options.

Learn more about working with Shopify's product model.
Anchor to productByIdentifierproductByIdentifier •Product: Return a product by an identifier.
Anchor to productDuplicateJobproductDuplicateJob •ProductDuplicateJob! non-null: Returns the product duplicate job.
Anchor to productFeedproductFeed •ProductFeed: Returns a ProductFeed resource by ID.
Anchor to productFeedsproductFeeds •ProductFeedConnection! non-null: The product feeds for the shop.
Anchor to productOperationproductOperation •ProductOperation: 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 CREATED, ACTIVE, or COMPLETE.

The product field provides the details of the created or updated product.

For the ProductSetOperation, the userErrors field provides mutation errors that occurred during the operation.
Anchor to productResourceFeedbackproductResourceFeedback •ProductResourceFeedback: Returns the product resource feedback for the currently authenticated app.
Anchor to productsproducts •ProductConnection! non-null: Retrieves a list of products in a store. Products are the items that merchants can sell in their store.

Use the products query when you need to:

Build a browsing interface for a product catalog.

Create product searching, sorting, and filtering experiences.

Implement product recommendations.

Sync product data with external systems.

The products query supports pagination to handle large product catalogs and saved searches for frequently used product queries.

The products query returns products with their associated metadata, including:

Basic product information (for example, title, description, vendor, and type)

Product options and product variants, with their prices and inventory

Media attachments (for example, images and videos)

SEO metadata

Product categories and tags

Product availability and publishing statuses

Learn more about working with Shopify's product model.
Anchor to productSavedSearchesproductSavedSearches •SavedSearchConnection! non-null: Returns a list of the shop's product saved searches.
Anchor to productsCountproductsCount •Count: Count of products. Limited to a maximum of 10000 by default.
Anchor to productTagsproductTags •StringConnection: A list of tags that have been added to products. The maximum page size is 5000.
Anchor to productTypesproductTypes •StringConnection: The list of types added to products. The maximum page size is 1000.
Anchor to productVariantproductVariant •ProductVariant: Retrieves a product variant by its ID.

A product variant is a specific version of a product that comes in more than one option, such as size or color. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another.

Use the productVariant query when you need to:

Access essential product variant data (for example, title, price, image, and metafields).

Build product detail pages and manage inventory.

Handle international sales with localized pricing and content.

Manage product variants that are part of a bundle or selling plan.

Learn more about working with Shopify's product model.
Anchor to productVariantByIdentifierproductVariantByIdentifier •ProductVariant: Return a product variant by an identifier.
Anchor to productVariantsproductVariants •ProductVariantConnection! non-null: Retrieves a list of product variants associated with a product.

A product variant is a specific version of a product that comes in more than one option, such as size or color. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another.

Use the productVariants query when you need to:

Search for product variants by attributes such as SKU, barcode, or inventory quantity.

Filter product variants by attributes, such as whether they're gift cards or have custom metafields.

Fetch product variants for bulk operations, such as updating prices or inventory.

Preload data for product variants, such as inventory items, selected options, or associated products.

The productVariants query supports pagination to handle large product catalogs and saved searches for frequently used product variant queries.

The productVariants query returns product variants with their associated metadata, including:

Basic product variant information (for example, title, SKU, barcode, price, and inventory)

Media attachments (for example, images and videos)

Associated products, selling plans, bundles, and metafields

Learn more about working with Shopify's product model.
Anchor to productVariantsCountproductVariantsCount •Count: Count of product variants. Limited to a maximum of 10000 by default.
Anchor to productVendorsproductVendors •StringConnection: The list of vendors added to products. The maximum page size is 1000.
Anchor to publicApiVersionspublicApiVersions •[ApiVersion!]! non-null: The list of publicly-accessible Admin API versions, including supported versions, the release candidate, and unstable versions.
Anchor to publicationpublication •Publication: Lookup a publication by ID.
Anchor to publicationspublications •PublicationConnection! non-null: List of publications.
Anchor to publicationsCountpublicationsCount •Count: Count of publications. Limited to a maximum of 10000 by default.
Anchor to publishedProductsCountpublishedProductsCount •Count: Returns a count of published products by publication ID. Limited to a maximum of 10000 by default.
Anchor to refundrefund •Refund: Returns a Refund resource by ID.
Anchor to returnreturn •Return: Retrieves a return by its ID. A return represents the intent of a buyer to ship one or more items from an order back to a merchant or a third-party fulfillment location.

Use the return query to retrieve information associated with the following workflows:

Managing returns

Processing exchanges

Tracking reverse fulfillment orders

A return is associated with an order and can include multiple return line items. Each return has a status, which indicates the state of the return.
Anchor to returnableFulfillmentreturnableFulfillment •ReturnableFulfillment: Lookup a returnable fulfillment by ID.
Anchor to returnableFulfillmentsreturnableFulfillments •ReturnableFulfillmentConnection! non-null: List of returnable fulfillments.
Anchor to returnCalculatereturnCalculate •CalculatedReturn: The calculated monetary value to be exchanged due to the return.
Anchor to reverseDeliveryreverseDelivery •ReverseDelivery: Lookup a reverse delivery by ID.
Anchor to reverseFulfillmentOrderreverseFulfillmentOrder •ReverseFulfillmentOrder: Lookup a reverse fulfillment order by ID.
Anchor to scriptTagscriptTag •ScriptTag: 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 scriptTagsscriptTags •ScriptTagConnection! non-null: 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 •Segment: The Customer Segment.
Anchor to segmentMigrationssegmentMigrations •SegmentMigrationConnection! non-null: A list of a shop's segment migrations.
Anchor to segmentssegments •SegmentConnection! non-null: A list of a shop's segments.
Anchor to segmentsCountsegmentsCount •Count: The number of segments for a shop. Limited to a maximum of 10000 by default.
Anchor to segmentValueSuggestionssegmentValueSuggestions •SegmentValueConnection! non-null: 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 sellingPlanGroupsellingPlanGroup •SellingPlanGroup: Returns a Selling Plan Group resource by ID.
Anchor to sellingPlanGroupssellingPlanGroups •SellingPlanGroupConnection! non-null: List Selling Plan Groups.
Anchor to serverPixelserverPixel •ServerPixel: 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 shopBillingPreferencesshopBillingPreferences •ShopBillingPreferences! non-null: The shop's billing preferences.
Anchor to shopifyFunctionshopifyFunction •ShopifyFunction: 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 shopifyFunctionsshopifyFunctions •ShopifyFunctionConnection! non-null: Returns the Shopify Functions owned by the querying API client installed on the shop.
Anchor to shopifyPaymentsAccountshopifyPaymentsAccount •ShopifyPaymentsAccount: Shopify Payments account information, including balances and payouts.
Anchor to shopLocalesshopLocales •[ShopLocale!]! non-null: A list of locales available on a shop.
Anchor to shopPayPaymentRequestReceiptshopPayPaymentRequestReceipt •ShopPayPaymentRequestReceipt: Returns a Shop Pay payment request receipt.
Anchor to shopPayPaymentRequestReceiptsshopPayPaymentRequestReceipts •ShopPayPaymentRequestReceiptConnection: Returns a list of Shop Pay payment request receipts.
Anchor to staffMemberstaffMember •StaffMember: The StaffMember resource, by ID.
Anchor to staffMembersstaffMembers •StaffMemberConnection: The shop staff members.
Anchor to standardMetafieldDefinitionTemplatesstandardMetafieldDefinitionTemplates •StandardMetafieldDefinitionTemplateConnection! non-null: 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 storeCreditAccountstoreCreditAccount •StoreCreditAccount: Returns a store credit account resource by ID.
Anchor to subscriptionBillingAttemptsubscriptionBillingAttempt •SubscriptionBillingAttempt: Returns a SubscriptionBillingAttempt by ID.
Anchor to subscriptionBillingAttemptssubscriptionBillingAttempts •SubscriptionBillingAttemptConnection! non-null: Returns subscription billing attempts on a store.
Anchor to subscriptionBillingCyclesubscriptionBillingCycle •SubscriptionBillingCycle: Returns a subscription billing cycle found either by cycle index or date.
Anchor to subscriptionBillingCycleBulkResultssubscriptionBillingCycleBulkResults •SubscriptionBillingCycleConnection! non-null: 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.
Anchor to subscriptionBillingCyclessubscriptionBillingCycles •SubscriptionBillingCycleConnection! non-null: Returns subscription billing cycles for a contract ID.
Anchor to subscriptionContractsubscriptionContract •SubscriptionContract: Returns a Subscription Contract resource by ID.
Anchor to subscriptionContractssubscriptionContracts •SubscriptionContractConnection! non-null: List Subscription Contracts.
Anchor to subscriptionDraftsubscriptionDraft •SubscriptionDraft: Returns a Subscription Draft resource by ID.
Anchor to subscriptionGatewaysubscriptionGateway •SubscriptionGateway: Gateway used for subscription charges.
Anchor to subscriptionMigrationGatewayssubscriptionMigrationGateways •[SubscriptionMigrationGateway!]! non-null: The list of payment gateways that can be used for subscription contract migrations.
Anchor to taxonomytaxonomy •Taxonomy: The Taxonomy resource lets you access the categories, attributes and values of the loaded taxonomy tree.
Anchor to tenderTransactionstenderTransactions •TenderTransactionConnection! non-null: Returns a list of TenderTransactions associated with the shop.
Anchor to themetheme •OnlineStoreTheme: Returns a particular theme for the shop.
Anchor to themesthemes •OnlineStoreThemeConnection: Returns a paginated list of themes for the shop.
Anchor to translatableResourcetranslatableResource •TranslatableResource: A resource that can have localized values for different languages.
Anchor to translatableResourcestranslatableResources •TranslatableResourceConnection! non-null: Resources that can have localized values for different languages.
Anchor to translatableResourcesByIdstranslatableResourcesByIds •TranslatableResourceConnection! non-null: Resources that can have localized values for different languages.
Anchor to urlRedirecturlRedirect •UrlRedirect: Returns a redirect resource by ID.
Anchor to urlRedirectImporturlRedirectImport •UrlRedirectImport: Returns a redirect import resource by ID.
Anchor to urlRedirectsurlRedirects •UrlRedirectConnection! non-null: A list of redirects for a shop.
Anchor to urlRedirectSavedSearchesurlRedirectSavedSearches •SavedSearchConnection! non-null: A list of the shop's URL redirect saved searches.
Anchor to urlRedirectsCounturlRedirectsCount •Count: Count of redirects. Limited to a maximum of 10000 by default.
Anchor to validationvalidation •Validation: Validation available on the shop.
Anchor to validationsvalidations •ValidationConnection! non-null: Validations available on the shop.
Anchor to webhookSubscriptionwebhookSubscription •WebhookSubscription: 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 webhookSubscriptionswebhookSubscriptions •WebhookSubscriptionConnection! non-null: 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 webhookSubscriptionsCountwebhookSubscriptionsCount •Count: 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.toml may 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 by default.
Anchor to webPixelwebPixel •WebPixel: Returns a web pixel by ID.
Anchor to webPresenceswebPresences •MarketWebPresenceConnection: The web presences for the shop.

Deprecated fields and connections

Anchor to automaticDiscountautomaticDiscount •DiscountAutomatic Deprecated
Anchor to automaticDiscountsautomaticDiscounts •DiscountAutomaticConnection! non-nullDeprecated
Anchor to channelchannel •Channel Deprecated
Anchor to channelschannels •ChannelConnection! non-nullDeprecated
Anchor to collectionByHandlecollectionByHandle •Collection Deprecated
Anchor to deletionEventsdeletionEvents •DeletionEventConnection! non-nullDeprecated
Anchor to gateConfigurationgateConfiguration •GateConfiguration Deprecated
Anchor to gateConfigurationsgateConfigurations •GateConfigurationConnection Deprecated
Anchor to locationsAvailableForDeliveryProfileslocationsAvailableForDeliveryProfiles •[Location!] Deprecated
Anchor to marketByGeographymarketByGeography •Market Deprecated
Anchor to primaryMarketprimaryMarket •Market! non-nullDeprecated
Anchor to productByHandleproductByHandle •Product Deprecated
Anchor to productTaxonomyNodesproductTaxonomyNodes •ProductTaxonomyNodeConnection! non-nullDeprecated

Was this section helpful?

Anchor to Fields and connectionsFields and connections

Theme app extensions

Script tag deprecation

Theme app extensions

Script tag deprecation

Deprecated fields and connections