Skip to main content
Log inSign up
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

•

Returns an abandonment by ID.

Anchor to abandonmentByAbandonedCheckoutIdabandonmentByAbandonedCheckoutId
•

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.

•

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 read_apps access scope. Public apps can't be granted this access scope.

Anchor to automaticDiscountNodeautomaticDiscountNode
•

Returns an automatic discount resource by ID.

Anchor to automaticDiscountNodesautomaticDiscountNodes
•

Returns a list of automatic discounts.

Anchor to automaticDiscountSavedSearchesautomaticDiscountSavedSearches
•

List of the shop's automatic discount saved searches.

Anchor to availableCarrierServicesavailableCarrierServices
•

Returns a list of activated carrier services and associated shop locations that support them.

•
[Locale!]!non-null

A list of available locales.

•

Returns a DeliveryCarrierService object by ID.

•

List of Cart transform objects owned by the current API client.

•

Lookup a cash tracking session by ID.

Anchor to cashTrackingSessionscashTrackingSessions
•

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.

Anchor to codeDiscountNodeByCodecodeDiscountNodeByCode
•

Returns a code discount identified by its discount code.

•

Returns a list of code-based discounts.

Anchor to codeDiscountSavedSearchescodeDiscountSavedSearches
•

List of the shop's code discount saved searches.

•

Returns a Collection resource by ID.

Anchor to collectionRulesConditionscollectionRulesConditions
•

Lists all rules that can be used to create smart collections.

•

Returns a list of collections.

Anchor to collectionSavedSearchescollectionSavedSearches
•

Returns a list of the shop's collection saved searches.

•

Returns the list of companies in the shop.

•

The number of companies for a shop.

•

Returns a Company object by ID.

•

Returns a CompanyContact object by ID.

•

Returns a CompanyContactRole object by ID.

•

Returns a CompanyLocation object by ID.

•

Returns the list of company locations in the shop.

Anchor to currentAppInstallationcurrentAppInstallation
•

Return the AppInstallation for the currently authenticated App.

Anchor to currentBulkOperationcurrentBulkOperation
•

Returns the current app's most recent BulkOperation. Apps can run one bulk query and one bulk mutation operation at a time, by shop.

•

Returns a Customer resource by ID.

Anchor to customerMergeJobStatuscustomerMergeJobStatus
•

Returns the status of a customer merge request job.

Anchor to customerMergePreviewcustomerMergePreview
•

Returns a preview of a customer merge request.

Anchor to customerPaymentMethodcustomerPaymentMethod
•

Returns a CustomerPaymentMethod resource by its ID.

•

Returns a list of customers.

Anchor to customerSegmentMemberscustomerSegmentMembers
•

The list of members, such as customers, that's associated with an individual segment. The maximum page size is 1000.

Anchor to customerSegmentMembershipcustomerSegmentMembership
•

Whether a member, which is a customer, belongs to a segment.

Anchor to customerSegmentMembersQuerycustomerSegmentMembersQuery
•

Returns a segment members query resource by ID.

Anchor to deliveryCustomizationdeliveryCustomization
•

The delivery customization.

Anchor to deliveryCustomizationsdeliveryCustomizations
•

The delivery customizations.

•

Returns a Delivery Profile resource by ID.

•

Returns a list of saved delivery profiles.

•

Returns the shop-wide shipping settings.

•

The total number of discount codes for the shop.

•

Returns a discount resource by ID.

•

Returns a list of discounts.

Anchor to discountRedeemCodeBulkCreationdiscountRedeemCodeBulkCreation
•

Returns a bulk code creation resource by ID.

Anchor to discountRedeemCodeSavedSearchesdiscountRedeemCodeSavedSearches
•

List of the shop's redeemed discount code saved searches.

•

Returns dispute details based on ID.

•

Returns dispute evidence details based on ID.

•

Lookup a Domain by ID.

•

Returns a DraftOrder resource by ID.

•

List of saved draft orders.

Anchor to draftOrderSavedSearchesdraftOrderSavedSearches
•

List of the shop's draft order saved searches.

•

Returns a DraftOrderTag resource by ID.

•

Returns a paginated list of files that have been uploaded to Shopify.

•

A list of the shop's file saved searches.

•

Returns a Fulfillment resource by ID.

Anchor to fulfillmentConstraintRulesfulfillmentConstraintRules
•

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.

•

Returns a gift card resource by ID.

•

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.

Anchor to locationsAvailableForDeliveryProfilesConnectionlocationsAvailableForDeliveryProfilesConnection
•

Returns a list of all origin locations available for a delivery profile.

Anchor to manualHoldsFulfillmentOrdersmanualHoldsFulfillmentOrders
•

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.

Anchor to marketLocalizableResourcemarketLocalizableResource
•

A resource that can have localized values for different markets.

Anchor to marketLocalizableResourcesmarketLocalizableResources
•

Resources that can have localized values for different markets.

Anchor to marketLocalizableResourcesByIdsmarketLocalizableResourcesByIds
•

Resources that can have localized values for different markets.

•

The markets configured for the shop.

•

Returns a metafield definition by identifier.

Anchor to metafieldDefinitionsmetafieldDefinitions
•

Returns a list of metafield definitions.

Anchor to metafieldDefinitionTypesmetafieldDefinitionTypes
•

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.

•

Retrieves a metaobject by ID.

•

Retrieves a metaobject by handle.

Anchor to metaobjectDefinitionmetaobjectDefinition
•

Retrieves a metaobject definition by ID.

Anchor to metaobjectDefinitionByTypemetaobjectDefinitionByType
•

Finds a metaobject definition by type.

Anchor to metaobjectDefinitionsmetaobjectDefinitions
•

All metaobject definitions.

•

All metaobjects for the shop.

•

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.

•
[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.

•

Returns an Order resource by 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.

Anchor to paymentCustomizationpaymentCustomization
•

The payment customization.

Anchor to paymentCustomizationspaymentCustomizations
•

The payment customizations.

Anchor to paymentTermsTemplatespaymentTermsTemplates
•

The list of payment terms templates eligible for all shops and users.

•

The number of pendings orders. Limited to a maximum of 10000.

•

Returns a price list resource by ID.

•

All price lists for a shop.

Anchor to priceRuleSavedSearchespriceRuleSavedSearches
•

List of the shop's price rule saved searches.

•

Returns a Product resource by ID.

•

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 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
•

Returns the product resource feedback for the currently authenticated app.

•

Returns a list of products.

Anchor to productSavedSearchesproductSavedSearches
•

Returns a list of the shop's product saved searches.

•

Count of products.

•

Returns a ProductVariant resource by ID.

•

Returns a list 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 Refund resource by ID.

•

Returns a Return resource by ID.

Anchor to returnableFulfillmentreturnableFulfillment
•

Lookup a returnable fulfillment by ID.

Anchor to returnableFulfillmentsreturnableFulfillments
•

List of returnable fulfillments.

•

Lookup a reverse delivery by ID.

Anchor to reverseFulfillmentOrderreverseFulfillmentOrder
•

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.

Anchor to segmentFilterSuggestionssegmentFilterSuggestions
•

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.

Anchor to segmentValueSuggestionssegmentValueSuggestions
•

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.

•
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
•

The shop's billing preferences.

•

Returns a Shopify Function by its ID. Functions enable you to customize Shopify's backend logic at defined parts of the commerce loop.

•

Returns the Shopify Functions owned by the querying API client installed on the shop.

Anchor to shopifyPaymentsAccountshopifyPaymentsAccount
•

Shopify Payments account information, including balances and payouts.

•

Returns the results of a ShopifyQL query. Refer to the ShopifyQL documentation for more information.

•

A list of locales available on a shop.

•

The StaffMember resource, by ID.

Anchor to standardMetafieldDefinitionTemplatesstandardMetafieldDefinitionTemplates
•

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 subscriptionBillingAttemptsubscriptionBillingAttempt
•

Returns a SubscriptionBillingAttempt by ID.

Anchor to subscriptionBillingAttemptssubscriptionBillingAttempts
•

Returns subscription billing attempts on a store.

Anchor to subscriptionBillingCyclesubscriptionBillingCycle
•

Returns a subscription billing cycle found either by cycle index or date.

Anchor to subscriptionBillingCyclessubscriptionBillingCycles
•

Returns subscription billing cycles for a contract ID.

Anchor to subscriptionContractsubscriptionContract
•

Returns a Subscription Contract resource by ID.

Anchor to subscriptionContractssubscriptionContracts
•

List Subscription Contracts.

•

Returns a Subscription Draft resource by ID.

•

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.

Anchor to translatableResourcetranslatableResource
•

A resource that can have localized values for different languages.

Anchor to translatableResourcestranslatableResources
•

Resources that can have localized values for different languages.

Anchor to translatableResourcesByIdstranslatableResourcesByIds
•

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.

Anchor to urlRedirectSavedSearchesurlRedirectSavedSearches
•

A list of the shop's URL redirect saved searches.

•

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.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
•

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.

•

Returns a web pixel by ID.

Show
deprecated fields and connections Deprecated
•

Returns an automatic discount resource by ID. Use automaticDiscountNode instead.

•

List of automatic discounts. Use automaticDiscountNodes instead.

•
ChannelDeprecated

Lookup a channel by ID. Use publication instead.

•
ChannelConnection!non-nullDeprecated

List of the active sales channels. Use publications instead.

•
CollectionDeprecated

Return a collection by its handle. Use collectionByIdentifier instead.

•
DeletionEventConnection!non-nullDeprecated

The paginated list of deletion events. Use events instead.

Anchor to locationsAvailableForDeliveryProfileslocationsAvailableForDeliveryProfiles
•
[Location!]Deprecated

Returns a list of all origin locations available for a delivery profile. Use locationsAvailableForDeliveryProfilesConnection instead.

Anchor to metafieldStorefrontVisibilitiesmetafieldStorefrontVisibilities
•

List of the MetafieldStorefrontVisibility records. This query will be removed in a future version. Use the access.storefront field for nodes inside the metafieldDefinitions query instead.

Anchor to metafieldStorefrontVisibilitymetafieldStorefrontVisibility
•

Returns a MetafieldStorefrontVisibility record by ID. A MetafieldStorefrontVisibility record lists the metafields to make visible in the Storefront API. This query will be removed in a future version. Use the access.storefront field inside the metafieldDefinition query instead.

•
PriceRuleDeprecated

Returns a code price rule resource by ID. Use codeDiscountNode instead.

•
PriceRuleConnection!non-nullDeprecated

Returns a list of price rule resources that have at least one associated discount code. Use codeDiscountNodes instead.

•
Market!non-nullDeprecated

The primary market of the shop. Use backupRegion instead.

•

Returns a private metafield by ID. Private metafields are accessible only by the application that created them. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.

•
PrivateMetafieldConnection!non-nullDeprecated

Returns a list of private metafields associated to a resource. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.

•
ProductDeprecated

Return a product by its handle. Use productByIdentifier instead.


Was this section helpful?