Query Root

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•AbandonedCheckoutSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: The date and time (in ISO 8601 format) when the abandoned cart was created.
Anchor to email_state •string: Filter by abandoned_email_state value. Possible values: sent, not_sent, scheduled and suppressed.
Anchor to id •id: Filter by id range.
Anchor to recovery_state •string: Possible values: recovered and not_recovered.
Anchor to status •string: Possible values: open and closed.
Anchor to updated_at •time: The date and time (in ISO 8601 format) when the abandoned cart was last updated.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to abandonedCheckoutsCountabandonedCheckoutsCount

•Count

Returns the count of abandoned checkouts for the given shop. Limited to a maximum of 10000 by default.

Arguments

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: The date and time (in ISO 8601 format) when the abandoned cart was created.
Anchor to email_state •string: Filter by abandoned_email_state value. Possible values: sent, not_sent, scheduled and suppressed.
Anchor to id •id: Filter by id range.
Anchor to recovery_state •string: Possible values: recovered and not_recovered.
Anchor to status •string: Possible values: open and closed.
Anchor to updated_at •time: The date and time (in ISO 8601 format) when the abandoned cart was last updated.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to abandonmentabandonment

•Abandonment

Returns a Abandonment resource by ID.

Anchor to idid •ID! required: The ID of the Abandonment to return.

Anchor to abandonmentByAbandonedCheckoutIdabandonmentByAbandonedCheckoutId

•Abandonment

Returns an Abandonment by the Abandoned Checkout ID.

Anchor to abandonedCheckoutIdabandonedCheckoutId •ID! required: The ID of the Abandoned Checkout ID to query by.

Anchor to allChannelsallChannels

•ChannelConnection!

non-null

List of all the active sales channels on this shop.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to appapp

•App

Retrieves an App by its ID. If no ID is provided, returns details about the currently authenticated app. The query provides access to app details including title, icon, and pricing information.

If the app isn't installed on the current shop, then the installation field will be null.

Anchor to idid •ID: The ID to lookup the App by.

Anchor to appByHandleappByHandle

•App

Retrieves an app by its unique handle. The handle is a URL-friendly identifier for the app.

Returns the App if found, or null if no app exists with the specified handle.

Anchor to handlehandle •String! required: Handle of the App.

Anchor to appByKeyappByKey

•App

Retrieves an App by its client ID (API key). Returns the app's configuration, installation status, AccessScope objects, and developer information.

Returns null if no app exists with the specified client ID.

Anchor to apiKeyapiKey •String! required: Client ID of the app.

Anchor to appCreditsappCredits

•AppCreditConnection!

non-null

Credits that can be used towards future app purchases.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•AppTransactionSortKeys

Default:CREATED_AT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to appDiscountTypeappDiscountType

•AppDiscountType

An app discount type.

Anchor to functionIdfunctionId •String! required: The ID for the function providing the 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 firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to appInstallationappInstallation

•AppInstallation

Retrieves an AppInstallation by ID. If no ID is provided, returns the installation for the currently authenticated App. The query provides essential data for validating installation state and managing app functionality within a store.

Use this query to access installation details including granted AccessScope objects, active AppSubscription objects, AppCredit objects, AppPurchaseOneTime objects, and app-specific metadata.

Learn more about app installation.

Anchor to idid •ID: ID used to lookup AppInstallation.

Anchor to appInstallationsappInstallations

•AppInstallationConnection!

non-null

A paginated list of AppInstallation objects across multiple stores where your app is installed. Use this query to monitor installation status, track billing and subscriptions through AppSubscription objects, and review granted AccessScope objects.

Filter by AppInstallationCategory to find specific types of installations (such as POS or channel apps) and by AppInstallationPrivacy to scope to public or private installations.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•AppInstallationSortKeys

Default:INSTALLED_AT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to categorycategory

•AppInstallationCategory

The category of app installations to fetch.

Anchor to privacyprivacy

•AppInstallationPrivacy

Default:PUBLIC

The privacy level of app installations to fetch.

Anchor to articlearticle

•Article

Returns a Article resource by ID.

Anchor to idid •ID! required: The ID of the Article to return.

Anchor to articleAuthorsarticleAuthors

•ArticleAuthorConnection!

non-null

List of article authors for the shop.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to articlesarticles

•ArticleConnection!

non-null

Returns a paginated list of articles from the shop's blogs. Article objects are blog posts that contain content like text, images, and tags.

Supports cursor-based pagination to control the number of articles returned and their order. Use the query argument to filter results by specific criteria.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•ArticleSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to author •string: Filter by the author of the article.
Anchor to blog_id •string: Filter by the ID of the blog the article belongs to.
Anchor to blog_title •string
Anchor to created_at •time: Filter by the date and time when the article was created.
Anchor to handle •string: Filter by the article's handle.
Anchor to id •id: Filter by id range.
Anchor to published_at •time: Filter by the date and time when the article was published.
Anchor to published_status •string: Filter by published status
Anchor to tag •string: Filter objects by the tag field.
Anchor to tag_not •string: Filter by objects that don’t have the specified tag.
Anchor to title •string: Filter by the title of the article.
Anchor to updated_at •time: Filter by the date and time when the article was last updated.

Anchor to articleTagsarticleTags

•[String!]!

non-null

List of all article tags.

Arguments

Anchor to sortsort

•ArticleTagSort

Default:ALPHABETICAL

Type of sort order.

•FulfillmentOrderConnection!

•Int!

required

The maximum number of tags to return.

Anchor to assignedFulfillmentOrdersassignedFulfillmentOrders

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.

Arguments

Anchor to assignmentStatusassignmentStatus

•FulfillmentOrderAssignmentStatus

The assigment status of the fulfillment orders that should be returned. If assignmentStatus argument is not provided, then the query will return all assigned fulfillment orders, except those that have the CLOSED status.

Anchor to locationIdslocationIds

•[ID!]

Returns fulfillment orders only for certain locations, specified by a list of location IDs.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•FulfillmentOrderSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to automaticDiscountNodeautomaticDiscountNode

•DiscountAutomaticNode

Returns a DiscountAutomaticNode resource by ID.

Anchor to idid •ID! required: The ID of the DiscountAutomaticNode to return.

Anchor to automaticDiscountSavedSearchesautomaticDiscountSavedSearches

•[DeliveryCarrierServiceAndLocations!]!

non-null

List of the shop's automatic discount saved searches.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to availableBackupRegionsavailableBackupRegions

•[MarketRegion!]!

non-null

The geographic regions that you can set as the Shop's backup region. The backup region serves as a fallback when the system can't determine a buyer's actual location.

Anchor to availableCarrierServicesavailableCarrierServices

non-null

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

Arguments

Anchor to destinationCountryCodesdestinationCountryCodes

•[CountryCode!]

An array of destination country codes.

Anchor to availableLocalesavailableLocales

•[Locale!]!

non-null

Returns all locales that Shopify supports. Each Locale includes an ISO code and human-readable name. Use this query to discover which locales you can enable on a shop with the shopLocaleEnable mutation.

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 idid •ID! required: The ID of the Blog to return.

Anchor to blogsblogs

•BlogConnection!

non-null

Returns a paginated list of the shop's Blog objects. Blogs serve as containers for Article objects and provide content management capabilities for the store's editorial content.

Supports cursor-based pagination to control the number of blogs returned and their order. Use the query argument to filter results by specific criteria.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•BlogSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time
Anchor to handle •string
Anchor to id •id: Filter by id range.
Anchor to title •string
Anchor to updated_at •time

Anchor to blogsCountblogsCount

•Count

Count of blogs. Limited to a maximum of 10000 by default.

Arguments

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time
Anchor to handle •string
Anchor to id •id: Filter by id range.
Anchor to title •string
Anchor to updated_at •time

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to bulkOperationbulkOperation

•BulkOperation

Returns a BulkOperation resource by ID.

Anchor to idid •ID! required: The ID of the BulkOperation to return.

Anchor to bulkOperationsbulkOperations

•BulkOperationConnection!

non-null

Returns the app's bulk operations meeting the specified filters. Defaults to sorting by created_at, with newest operations first.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•BulkOperationsSortKeys

Default:CREATED_AT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•DeliveryCarrierServiceConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to created_at •time: Filter operations created after a specific date.
Anchor to id •id: Filter by id range.
Anchor to operation_type •string: Filter operations by type.
Anchor to status •string: Filter operations by status.

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 the list of business entities associated with the shop. Use this query to retrieve business entities for assigning to markets, managing payment providers per entity, or viewing entity attribution on orders.

Each shop can have multiple business entities with one designated as primary. To identify the primary entity in the query results, set the primary field to true.

Learn more about managing multiple legal entities.

Anchor to businessEntitybusinessEntity

•BusinessEntity

Returns a Business Entity by ID.

Anchor to idid •ID: The ID of the Business Entity to return. Returns the primary Business Entity if not provided.

Anchor to carrierServicecarrierService

•DeliveryCarrierService

Returns a DeliveryCarrierService resource by ID.

Anchor to idid •ID! required: The ID of the DeliveryCarrierService to return.

Anchor to carrierServicescarrierServices

non-null

A paginated list of carrier services configured for the shop. Carrier services provide real-time shipping rates from external providers like FedEx, UPS, or custom shipping solutions. Use the query parameter to filter results by attributes such as active status.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CarrierServiceSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•CashTrackingSessionConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to active •boolean
Anchor to id •id: Filter by id range.

Anchor to cartTransformscartTransforms

•CartTransformConnection!

non-null

Retrieves all cart transform functions currently deployed by your app within the merchant's store. This query provides comprehensive access to your active cart modification logic, enabling management and monitoring of bundling and merchandising features.

The query returns paginated results with full cart transform details, including function IDs, configuration settings, and operational status.

Cart Transform ownership is scoped to your API client, ensuring you only see and manage functions deployed by your specific app. This isolation prevents conflicts between different apps while maintaining security boundaries for sensitive merchandising logic.

Learn more about managing cart transforms.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to cashTrackingSessioncashTrackingSession

•CashTrackingSession

Returns a CashTrackingSession resource by ID.

Anchor to idid •ID! required: The ID of the CashTrackingSession to return.

Anchor to cashTrackingSessionscashTrackingSessions

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.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CashTrackingSessionsSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to closing_time •time
Anchor to id •id: Filter by id range.
Anchor to location_id •id
Anchor to opening_time •time
Anchor to point_of_sale_device_ids •string
Anchor to status •string

Anchor to catalogcatalog

•Catalog

Retrieves a catalog by its ID. A catalog represents a list of products with publishing and pricing information, and can be associated with a context, such as a market, company location, or app.

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

Managing product publications across different contexts
Setting up contextual pricing with price lists
Managing market-specific product availability
Configuring B2B customer catalogs

There are several types of catalogs:

Learn more about catalogs for different markets.

Anchor to idid •ID! required: The ID of the Catalog to return.

Anchor to catalogOperationscatalogOperations

•[ResourceOperation!]!

non-null

Returns the most recent catalog operations for the shop.

Anchor to catalogscatalogs

•CatalogConnection!

non-null

Returns a paginated list of catalogs for the shop. Catalogs control which products are published and how they're priced in different contexts, such as international markets (Canada vs. United States), B2B company locations (different branches of the same business), or specific sales channels (such as online store vs. POS).

Filter catalogs by type and use the query argument to search and filter by additional criteria.

Learn more about Shopify Catalogs.

Arguments

Default:null

The type of the catalogs to be returned.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CatalogSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to app_id •id
Anchor to company_id •id
Anchor to company_location_id •id
Anchor to id •id: Filter by id range.
Anchor to managed_country_id •id
Anchor to market_id •id
Anchor to status •string
Anchor to title •string

Anchor to catalogsCountcatalogsCount

•Count

The count of catalogs belonging to the shop. Limited to a maximum of 10000 by default.

Arguments

Default:null

The type of the catalogs to be returned.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to app_id •id
Anchor to company_id •id
Anchor to company_location_id •id
Anchor to id •id: Filter by id range.
Anchor to managed_country_id •id
Anchor to market_id •id
Anchor to status •string
Anchor to title •string

•CheckoutAndAccountsAppConfiguration

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to channelchannel

•Channel

Returns a Channel resource by ID.

Anchor to idid •ID! required: The ID of the Channel to return.

Anchor to channelschannels

•ChannelConnection!

non-null

Returns active channels where merchants sell products and collections. Each channel is an authenticated link to an external platform such as marketplaces, social media platforms, online stores, or point-of-sale systems.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to checkoutAndAccountsAppConfigurationcheckoutAndAccountsAppConfiguration

Returns the checkout and accounts app configuration for the current API client and shop.

Anchor to checkoutBrandingcheckoutBranding

•CheckoutBranding

Returns the visual customizations for checkout for a given checkout profile.

To update checkout branding settings, use the checkoutBrandingUpsert mutation. Learn more about customizing checkout's appearance.

Anchor to checkoutProfileIdcheckoutProfileId •ID! required: A globally-unique identifier.

Anchor to checkoutProfilecheckoutProfile

•CheckoutProfile

Returns a CheckoutProfile. Checkout profiles define the branding settings and UI extensions for a store's checkout experience. Stores can have one published profile that renders on their live checkout and multiple draft profiles for testing customizations in the checkout editor.

Anchor to idid •ID! required: The ID of the checkout profile.

Anchor to checkoutProfilescheckoutProfiles

•CheckoutProfileConnection!

non-null

List of checkout profiles on a shop.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CheckoutProfileSortKeys

Default:UPDATED_AT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to id •id: Filter by id range.
Anchor to is_published •boolean

Anchor to codeDiscountNodecodeDiscountNode

•DiscountCodeNode

Returns a code discount resource by ID.

Anchor to idid •ID! required: The ID of the DiscountCodeNode to return.

Anchor to codeDiscountNodeByCodecodeDiscountNodeByCode

•DiscountCodeNode

Retrieves a code discount by its discount code. The search is case-insensitive, enabling you to find discounts regardless of how customers enter the code.

Returns a DiscountCodeNode that contains the underlying discount details, which could be a basic amount off discount, a "Buy X Get Y" (BXGY) discount, a free shipping discount, or an app-provided discount.

Learn more about working with Shopify's discount model.

Anchor to codecode •String! required: The case-insensitive code of the DiscountCodeNode to return.

Anchor to codeDiscountSavedSearchescodeDiscountSavedSearches

•[CollectionRuleConditions!]!

non-null

List of the shop's code discount saved searches.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to collectioncollection

•Collection

Retrieves a collection by its ID. A collection represents a grouping of products that merchants can display and sell as a group in their online store and other sales channels.

Use the collection query when you need to:

Manage collection publishing across sales channels
Access collection metadata and SEO information
Work with collection rules and product relationships

A collection can be either a custom (manual) collection where products are manually added, or a smart (automated) collection where products are automatically included based on defined rules. Each collection has associated metadata including title, description, handle, image, and metafields.

Anchor to idid •ID! required: The ID of the Collection to return.

Anchor to collectionByIdentifiercollectionByIdentifier

•Collection

Return a collection by an identifier.

Arguments

Anchor to identifieridentifier

•CollectionIdentifierInput!

required

The identifier of the collection.

Anchor to collectionRulesConditionscollectionRulesConditions

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.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CollectionSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to collection_type •string
Anchor to handle •string
Anchor to id •id: Filter by id range.
Anchor to product_id •id: Filter by collections containing a product by its ID.
Anchor to product_publication_status •string: Filter by channel approval process status of the resource on a channel, such as the online store. The value is a composite of the channel app ID (Channel.app.id) and one of the valid values. For simple visibility checks, use published_status instead.
Anchor to publishable_status •string: Deprecated: This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use published_status for visibility checks. Filter by the publishable status of the resource on a channel. The value is a composite of the channel app ID (Channel.app.id) and one of the valid status values.
Anchor to published_at •time: Filter by the date and time when the collection was published to the Online Store.
Anchor to published_status •string: Filter resources by their visibility and publication state on a channel. Online store channel filtering: - online_store_channel: Returns all resources in the online store channel, regardless of publication status. - published/visible: Returns resources that are published to the online store. - unpublished: Returns resources that are not published to the online store. Channel-specific filtering using the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel.
Anchor to title •string
Anchor to updated_at •time

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to collectionSavedSearchescollectionSavedSearches

non-null

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

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to collectionsCountcollectionsCount

•Count

Count of collections. Limited to a maximum of 10000 by default.

Arguments

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to collection_type •string
Anchor to handle •string
Anchor to id •id: Filter by id range.
Anchor to product_id •id: Filter by collections containing a product by its ID.
Anchor to product_publication_status •string: Filter by channel approval process status of the resource on a channel, such as the online store. The value is a composite of the channel app ID (Channel.app.id) and one of the valid values. For simple visibility checks, use published_status instead.
Anchor to publishable_status •string: Deprecated: This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use published_status for visibility checks. Filter by the publishable status of the resource on a channel. The value is a composite of the channel app ID (Channel.app.id) and one of the valid status values.
Anchor to published_at •time: Filter by the date and time when the collection was published to the Online Store.
Anchor to published_status •string: Filter resources by their visibility and publication state on a channel. Online store channel filtering: - online_store_channel: Returns all resources in the online store channel, regardless of publication status. - published/visible: Returns resources that are published to the online store. - unpublished: Returns resources that are not published to the online store. Channel-specific filtering using the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel.
Anchor to title •string
Anchor to updated_at •time

Anchor to savedSearchIdsavedSearchId

•ID

The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to commentcomment

•Comment

Returns a Comment resource by ID.

Anchor to idid •ID! required: The ID of the Comment to return.

Anchor to commentscomments

•CommentConnection!

non-null

List of the shop's comments.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CommentSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the comment was created.
Anchor to id •id: Filter by id range.
Anchor to published_at •time: Filter by the date and time when the comment was published.
Anchor to published_status •string: Filter by published status
Anchor to status •string
Anchor to updated_at •time: Filter by the date and time when the comment was last updated.

Anchor to companiescompanies

•CompanyConnection!

non-null

A paginated list of companies in the shop. Company objects are business entities that purchase from the merchant.

Use the query argument to filter companies by attributes like name or externalId. Sort and paginate results to handle large datasets efficiently. Learn more about Shopify API search syntax.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CompanySortKeys

Default:ID

Sort the underlying list by the given key.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to active_customers_count •integer
Anchor to created_at •time
Anchor to external_id •id
Anchor to id •id: Filter by id range.
Anchor to metafields.{namespace}.{key} •mixed: Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.
Anchor to name •string
Anchor to since_date •time
Anchor to updated_at •time

Anchor to companiesCountcompaniesCount

•Count

The number of companies for a shop. Limited to a maximum of 10000 by default.

Anchor to limitlimit •Int Default:10000: The upper bound on count value before returning a result. Use null to have no limit.

Anchor to companycompany

•Company

Returns a Company resource by ID.

Anchor to idid •ID! required: The ID of the Company to return.

Anchor to companyContactcompanyContact

•CompanyContact

Returns a CompanyContact resource by ID.

Anchor to idid •ID! required: The ID of the CompanyContact to return.

Anchor to companyContactRolecompanyContactRole

•CompanyContactRole

Returns a CompanyContactRole resource by ID.

Anchor to idid •ID! required: The ID of the CompanyContactRole to return.

Anchor to companyLocationcompanyLocation

•CompanyLocation

Returns a CompanyLocation resource by ID.

Anchor to idid •ID! required: The ID of the CompanyLocation to return.

Anchor to companyLocationscompanyLocations

•CompanyLocationConnection!

non-null

A paginated list of CompanyLocation objects for B2B customers. Company locations represent individual branches or offices of a Company where B2B orders can be placed.

Each location can have its own billing and shipping addresses, tax settings, PaymentTerms, and Catalog assignments with custom pricing. Use the query parameter to search locations by name or other attributes.

Learn more about managing company locations.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CompanyLocationSortKeys

Default:ID

Sort the underlying list by the given key.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to company_id •id
Anchor to created_at •time
Anchor to external_id •string
Anchor to id •id: Filter by id range.
Anchor to ids •string
Anchor to metafields.{namespace}.{key} •mixed: Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.
Anchor to name •string
Anchor to updated_at •time

Anchor to consentPolicyconsentPolicy

•[ConsentPolicy!]!

non-null

Returns the customer privacy consent policies of a shop.

Arguments

Anchor to idid

•ID

Return the policy with the provided ID.

Anchor to countryCodecountryCode

•PrivacyCountryCode

Return policies with the provided country code.

Anchor to regionCoderegionCode

•String

Return policies with the provided region code.

Anchor to consentRequiredconsentRequired

Return policies where consent is required or not.

Anchor to dataSaleOptOutRequireddataSaleOptOutRequired

•CustomerAccountPageConnection

Return policies where data sale opt out is required or not.

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

Returns the AppInstallation for the currently authenticated app. Provides access to granted access scopes, active AppSubscription objects, and billing information for your app.

Use this query to check which permissions your app has, monitor subscription status, or retrieve AppCredit objects. Learn more about managing access scopes, subscription billing, and app credits.

Anchor to currentStaffMembercurrentStaffMember

•StaffMember

The staff member making the API request.

Anchor to customercustomer

•Customer

Returns a Customer resource by ID.

Anchor to idid •ID! required: The ID of the Customer to return.

Anchor to customerAccountPagecustomerAccountPage

•CustomerAccountPage

Returns a CustomerAccountPage resource by ID.

Anchor to idid •ID! required: The ID of the CustomerAccountPage to return.

Anchor to customerAccountPagescustomerAccountPages

List of the shop's customer account pages.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to customerByIdentifiercustomerByIdentifier

•Customer

Return a customer by an identifier.

Arguments

Anchor to identifieridentifier

•CustomerIdentifierInput!

required

The identifier of the customer.

Anchor to customerMergeJobStatuscustomerMergeJobStatus

•CustomerMergeRequest

Returns the status of a customer merge request job.

Anchor to jobIdjobId •ID! required: The ID of the job performing the customer merge request.

Anchor to customerMergePreviewcustomerMergePreview

•CustomerMergePreview!

non-null

Returns a preview of a customer merge request.

Arguments

Anchor to customerOneIdcustomerOneId

•ID!

required

The ID of the first customer that will be merged.

Anchor to customerTwoIdcustomerTwoId

•ID!

required

The ID of the second customer that will be merged.

Anchor to overrideFieldsoverrideFields

•CustomerMergeOverrideFields

The fields to override the default customer merge rules.

Anchor to customerPaymentMethodcustomerPaymentMethod

•CustomerPaymentMethod

Returns a CustomerPaymentMethod resource by its ID.

Anchor to idid •ID! required: The ID of the CustomerPaymentMethod to return.
Anchor to showRevokedshowRevoked •Boolean Default:false: Whether to show the customer's revoked payment method.

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.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CustomerSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to accepts_marketing •boolean: Filter by whether a customer has consented to receive marketing material.
Anchor to country •string: Filter by the country associated with the customer's address. Use either the country name or the two-letter country code.
Anchor to customer_date •time: Filter by the date and time when the customer record was created. This query parameter filters by the createdAt field.
Anchor to email •string: The customer's email address, used to communicate information about orders and for the purposes of email marketing campaigns. You can use a wildcard value to filter the query by customers who have an email address specified. Please note that email is a tokenized field: To retrieve exact matches, quote the email address (phrase query) as described in Shopify API search syntax.
Anchor to first_name •string: Filter by the customer's first name.
Anchor to id •id: Filter by id range.
Anchor to last_abandoned_order_date •time: Filter by the date and time of the customer's most recent abandoned checkout. An abandoned checkout occurs when a customer adds items to their cart, begins the checkout process, but leaves the site without completing their purchase.
Anchor to last_name •string: Filter by the customer's last name.
Anchor to order_date •time: Filter by the date and time that the order was placed by the customer. Use this query filter to check if a customer has placed at least one order within a specified date range.
Anchor to orders_count •integer: Filter by the total number of orders a customer has placed.
Anchor to phone •string: The phone number of the customer, used to communicate information about orders and for the purposes of SMS marketing campaigns. You can use a wildcard value to filter the query by customers who have a phone number specified.
Anchor to state •string: Filter by the state of the customer's account with the shop. This filter is only valid when Classic Customer Accounts is active.
Anchor to tag •string: Filter by the tags that are associated with the customer. This query parameter accepts multiple tags separated by commas.
Anchor to tag_not •string: Filter by the tags that aren't associated with the customer. This query parameter accepts multiple tags separated by commas.
Anchor to total_spent •float: Filter by the total amount of money a customer has spent across all orders.
Anchor to updated_at •time: The date and time, matching a whole day, when the customer's information was last updated.

Anchor to customerSavedSearchescustomerSavedSearches

non-null

List of the shop's customer saved searches.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CustomerSavedSearchSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to id •id: Filter by id range.
Anchor to name •string

Anchor to customersCountcustomersCount

•Count

The number of customers. Limited to a maximum of 10000 by default.

Arguments

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to updated_at •time

•CustomerSegmentMemberConnection!

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to customerSegmentMemberscustomerSegmentMembers

non-null

A paginated list of customers that belong to an individual Segment. Segments group customers based on criteria defined through ShopifyQL queries. Access segment members with their profile information and purchase summary data. The connection includes statistics for analyzing segment attributes (such as average and sum calculations) and a total count of all members. The maximum page size is 1000.

Anchor to segmentIdsegmentId •ID: The ID of the segment.
Anchor to queryquery •String: The query that's used to filter the members. The query is composed of a combination of conditions on facts about customers such as email_subscription_status = 'SUBSCRIBED' with this syntax.
Anchor to queryIdqueryId •ID: The ID of the segment members query.
Anchor to timezonetimezone •String: The timezone that's used to interpret relative date arguments. The timezone defaults to UTC if the timezone isn't provided.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the list. The sorting behaviour defaults to ascending order.
Anchor to sortKeysortKey •String: Sort the list by a given key. Valid values: • created_at - Sort by customer creation date • first_order_date - Sort by the date of the customer's first order • last_abandoned_order_date - Sort by the date of the customer's last abandoned checkout • last_order_date - Sort by the date of the customer's most recent order • number_of_orders - Sort by the total number of orders placed by the customer • amount_spent - Sort by the total amount the customer has spent across all orders

Use with the reverse parameter to control sort direction (ascending by default, descending when reverse=true).
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.

Anchor to customerSegmentMembersCountcustomerSegmentMembersCount

•Count

Returns the total number of customers who match the criteria defined in a customer segment. This count provides real-time visibility into segment size for targeting and analysis purposes.

For example, check the size of a "High-Value Customers" segment before launching a VIP program.

The count reflects current segment membership based on the segment's filter criteria, updating as customer data changes and new customers meet or no longer meet the segment conditions.

Anchor to segmentIdsegmentId •ID: The ID of the segment.
Anchor to queryquery •String: The query that's used to filter the members. The query is composed of a combination of conditions on facts about customers such as email_subscription_status = 'SUBSCRIBED' with this syntax.
Anchor to queryIdqueryId •ID: The ID of the segment members query.

Anchor to customerSegmentMembershipcustomerSegmentMembership

•SegmentMembershipResponse!

non-null

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

Anchor to segmentIdssegmentIds •[ID!]! required: The segments to evaluate for the given customer.
Anchor to customerIdcustomerId •ID! required: The ID of the customer that has the membership.

Anchor to customerSegmentMembersQuerycustomerSegmentMembersQuery

•CustomerSegmentMembersQuery

Returns a CustomerSegmentMembersQuery resource by ID.

Anchor to idid •ID! required: The ID of the CustomerSegmentMembersQuery to return.

Anchor to deliveryCustomizationdeliveryCustomization

•DeliveryCustomization

The delivery customization.

Anchor to idid •ID! required: The ID of the delivery customization.

Anchor to deliveryCustomizationsdeliveryCustomizations

•DeliveryCustomizationConnection!

non-null

The delivery customizations.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to enabled •boolean
Anchor to function_id •string
Anchor to id •id: Filter by id range.

Anchor to deliveryProfiledeliveryProfile

•DeliveryProfile

Retrieves a DeliveryProfile by ID. Delivery profiles group shipping settings for specific Product objects that ship from selected Location objects to [delivery zones](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryZone with defined rates.

Learn more about delivery profiles.

Anchor to idid •ID! required: The ID of the DeliveryProfile to return.

Anchor to deliveryProfilesdeliveryProfiles

•DeliveryProfileConnection!

non-null

Returns a paginated list of DeliveryProfile objects for the shop. Delivery profiles group Product and ProductVariant objects that share shipping rates and zones.

Each profile contains DeliveryLocationGroup objects that organize fulfillment Location objects and their associated delivery zones. DeliveryZone objects define geographic regions with specific shipping methods and rates. Use the merchantOwnedOnly filter to exclude profiles that third-party apps manage.

Learn more about delivery profiles.

Arguments

Anchor to merchantOwnedOnlymerchantOwnedOnly

If true, returns only delivery profiles that were created by the merchant.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•DeliveryProfileSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•DeliveryPromiseParticipantConnection

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •boolean: Filter by the delivery profile default status.
Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to name •string
Anchor to updated_at •time

Anchor to deliveryPromiseParticipantsdeliveryPromiseParticipants

Returns delivery promise participants.

Arguments

Anchor to ownerIdsownerIds

•[ID!]

The product variant ID to filter by.

Anchor to brandedPromiseHandlebrandedPromiseHandle

•String!

required

The branded promise handle to filter by.

Anchor to ownerTypeownerType

•DeliveryPromiseParticipantOwnerType

The owner type to filter by.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Anchor to deliveryPromiseProviderdeliveryPromiseProvider

•DeliveryPromiseProvider

Lookup a delivery promise provider.

Anchor to locationIdlocationId •ID! required: The ID of the location associated with the 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 skusku •String! required: The SKU to be associated with the setting.
Anchor to deliveryPromiseProviderIddeliveryPromiseProviderId •ID! required: The ID of the delivery promise provider.

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.

Arguments

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to id •id: Filter by id range.
Anchor to times_used •integer

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to discountNodediscountNode

•DiscountNode

Returns a DiscountNode resource by ID.

Anchor to idid •ID! required: The ID of the DiscountNode to return.

Anchor to discountNodesdiscountNodes

•DiscountNodeConnection!

non-null

Returns a list of discounts.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•DiscountSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to code •string: Filter by the discount code. Not supported for bulk discounts.
Anchor to combines_with •string: Filter by the Shopify Functions discount classes that the discount type can combine with.
Anchor to created_at •time: Filter by the date and time, in the shop's timezone, when the discount was created.
Anchor to discount_class •string: Filter by the discount class.
Anchor to discount_type •string: Filter by the discount type.
Anchor to ends_at •time: Filter by the date and time, in the shop's timezone, when the discount ends.
Anchor to id •id: Filter by id range.
Anchor to method •string: Filter by the discount method.
Anchor to starts_at •time: Filter by the date and time, in the shop's timezone, when the discount becomes active and is available for customer use.
Anchor to status •string: Filter by the status of the discount.
Anchor to times_used •integer: Filter by the number of times the discount has been used. For example, if a "Buy 3, Get 1 Free" t-shirt discount is automatically applied in 200 transactions, then the discount has been used 200 times.

This value is updated asynchronously. As a result, it might be different than the actual usage count.
Anchor to title •string: Filter by the discount name that displays to merchants in the Shopify admin and to customers.
Anchor to type •string: Filter by the discount type.
Anchor to updated_at •time: Filter by the date and time, in the shop's timezone, when the discount was last updated.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to discountNodesCountdiscountNodesCount

•Count

The total number of discounts for the shop. Limited to a maximum of 10000 by default.

Arguments

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to code •string: Filter by the discount code. Not supported for bulk discounts.
Anchor to combines_with •string: Filter by the Shopify Functions discount classes that the discount type can combine with.
Anchor to created_at •time: Filter by the date and time, in the shop's timezone, when the discount was created.
Anchor to discount_class •string: Filter by the discount class.
Anchor to discount_type •string: Filter by the discount type.
Anchor to ends_at •time: Filter by the date and time, in the shop's timezone, when the discount ends.
Anchor to id •id: Filter by id range.
Anchor to method •string: Filter by the discount method.
Anchor to starts_at •time: Filter by the date and time, in the shop's timezone, when the discount becomes active and is available for customer use.
Anchor to status •string: Filter by the status of the discount.
Anchor to times_used •integer: Filter by the number of times the discount has been used. For example, if a "Buy 3, Get 1 Free" t-shirt discount is automatically applied in 200 transactions, then the discount has been used 200 times.

This value is updated asynchronously. As a result, it might be different than the actual usage count.
Anchor to title •string: Filter by the discount name that displays to merchants in the Shopify admin and to customers.
Anchor to type •string: Filter by the discount type.
Anchor to updated_at •time: Filter by the date and time, in the shop's timezone, when the discount was last updated.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.

•DiscountRedeemCodeBulkCreation

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to discountRedeemCodeBulkCreationdiscountRedeemCodeBulkCreation

Returns a DiscountRedeemCodeBulkCreation resource by ID.

Anchor to idid •ID! required: The ID of the DiscountRedeemCodeBulkCreation to return.

Anchor to discountRedeemCodeSavedSearchesdiscountRedeemCodeSavedSearches

non-null

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

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•DiscountCodeSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•ShopifyPaymentsDisputeEvidence

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to id •id: Filter by id range.
Anchor to times_used •integer

Anchor to discountResourceFeedbackdiscountResourceFeedback

•DiscountResourceFeedback

Returns the discount resource feedback for the currently authenticated app.

Anchor to idid •ID! required: The discount associated with the resource feedback.

Anchor to disputedispute

•ShopifyPaymentsDispute

Returns a ShopifyPaymentsDispute resource by ID.

Anchor to idid •ID! required: The ID of the ShopifyPaymentsDispute to return.

Anchor to disputeEvidencedisputeEvidence

Returns a ShopifyPaymentsDisputeEvidence resource by ID.

Anchor to idid •ID! required: The ID of the ShopifyPaymentsDisputeEvidence to return.

Anchor to disputesdisputes

•ShopifyPaymentsDisputeConnection!

non-null

All disputes related to the Shop.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•DraftOrderAvailableDeliveryOptions!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to id •id: Filter by id range.
Anchor to initiated_at •time
Anchor to status •string

Anchor to domaindomain

•Domain

Returns a Domain resource by ID.

Anchor to idid •ID! required: The ID of the Domain to return.

Anchor to draftOrderdraftOrder

•DraftOrder

Retrieves a draft order by its ID. A draft order is an order created by a merchant on behalf of their customers. Draft orders contain all necessary order details (products, pricing, customer information) but require payment to be accepted before they can be converted into completed orders.

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

Creating orders for phone, in-person, or chat sales
Sending invoices to customers with secure checkout links
Managing custom items and additional costs
Selling products at discount or wholesale rates
Processing pre-orders and saving drafts for later completion

A draft order is associated with a customer and contains multiple line items. Each draft order has a status, which indicates its progress through the sales workflow.

Anchor to idid •ID! required: The ID of the DraftOrder to return.

Anchor to draftOrderAvailableDeliveryOptionsdraftOrderAvailableDeliveryOptions

non-null

Available delivery options for a DraftOrder based on the provided input. The query returns shipping rates, local delivery rates, and pickup locations that merchants can choose from when creating draft orders.

Accepts draft order details including LineItem objects, MailingAddress for shipping, and discounts to determine which delivery methods are available. Pagination parameters control the number of local pickup options returned.

Arguments

Anchor to inputinput

•DraftOrderAvailableDeliveryOptionsInput!

required

The fields for the draft order.

Anchor to searchsearch

•String

The search term for the delivery options.

Anchor to localPickupFromlocalPickupFrom

•Int

The offset for the local pickup options.

Anchor to localPickupCountlocalPickupCount

•Int

The number of local pickup options required.

Anchor to sessionTokensessionToken

•String

Unique token used to trace execution and help optimize the calculation.

Anchor to draftOrdersdraftOrders

•DraftOrderConnection!

non-null

List of saved draft orders.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•DraftOrderSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time
Anchor to customer_id •id
Anchor to id •id: Filter by id range.
Anchor to source •string
Anchor to status •string
Anchor to tag •string
Anchor to updated_at •time

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to draftOrderSavedSearchesdraftOrderSavedSearches

non-null

List of the shop's draft order saved searches.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to draftOrdersCountdraftOrdersCount

•Count

Returns the number of draft orders that match the query. Limited to a maximum of 10000 by default.

Arguments

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time
Anchor to customer_id •id
Anchor to id •id: Filter by id range.
Anchor to ids •string
Anchor to source •string
Anchor to status •string
Anchor to tag •string
Anchor to updated_at •time

Anchor to savedSearchIdsavedSearchId

•ID

The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to draftOrderTagdraftOrderTag

•DraftOrderTag

Returns a DraftOrderTag resource by ID.

Anchor to idid •ID! required: The ID of the DraftOrderTag to return.

Anchor to eventevent

•Event

Retrieves a single event by ID. Events chronicle activities in your store such as resource creation, updates, or staff comments. The query returns an Event interface of type BasicEvent or CommentEvent.

Anchor to idid •ID! required: The ID of the event.

Anchor to eventsevents

•EventConnection

A paginated list of events that chronicle activities in the store. Event is an interface implemented by types such as BasicEvent and CommentEvent that track actions such as creating Article objects, fulfilling Order objects, adding Product objects, or staff comments on timelines.

The query supports filtering and sorting to help you find specific events or audit store activity over time.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•EventSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

Anchor to eventsCounteventsCount

•Count

Count of events. Limited to a maximum of 10000.

Arguments

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

Anchor to filesfiles

•FileConnection!

non-null

Retrieves a paginated list of files that have been uploaded to a Shopify store. Files represent digital assets that merchants can upload to their store for various purposes including product images, marketing materials, documents, and brand assets.

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

Managing product media and images
Theme development and asset management
Brand asset management and checkout branding

Files can include multiple content types, such as images, videos, 3D models, and generic files. Each file has properties like dimensions, file size, alt text for accessibility, and upload status. Files can be filtered by media type and can be associated with products, themes, and other store resources.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•FileSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time
Anchor to filename •string
Anchor to id •id: Filter by id range.
Anchor to ids •string
Anchor to media_type •string
Anchor to original_upload_size •float
Anchor to product_id •string
Anchor to status •string
Anchor to updated_at •time
Anchor to used_in •string

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to fileSavedSearchesfileSavedSearches

•[FulfillmentConstraintRule!]!

non-null

A list of the shop's file saved searches.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

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

Retrieves a Fulfillment by its ID. A fulfillment is a record that the merchant has completed their work required for one or more line items in an Order. It includes tracking information, LineItem objects, and the status of the fulfillment.

Use this query to track the progress of shipped items, view tracking details, or check fulfillment events for example when a package is out for delivery or delivered.

Anchor to idid •ID! required: The ID of the Fulfillment to return.

Anchor to fulfillmentConstraintRulesfulfillmentConstraintRules

non-null

The fulfillment constraint rules that belong to a shop.

Anchor to fulfillmentOrderfulfillmentOrder

•FulfillmentOrder

Returns a FulfillmentOrder resource by ID.

Anchor to idid •ID! required: The ID of the FulfillmentOrder to return.

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.

Arguments

Anchor to includeClosedincludeClosed

Default:false

Whether to include closed fulfillment orders.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•FulfillmentOrderSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to assigned_location_id •id
Anchor to id •id: Filter by id range.
Anchor to status •string
Anchor to updated_at •time

Anchor to fulfillmentServicefulfillmentService

•FulfillmentService

Returns a FulfillmentService by its ID. The service can manage inventory, process fulfillment requests, and provide tracking details through callback endpoints or directly calling Shopify's APIs.

When you register a fulfillment service, Shopify automatically creates an associated Location where fulfillment order's can be assigned to be processed.

Learn more about building fulfillment service apps.

Anchor to idid •ID! required: The ID of the FulfillmentService to return.

Anchor to giftCardgiftCard

•GiftCard

Retrieves a GiftCard by its ID. Returns the gift card's balance, transaction history, Customer information, and whether it's enabled.

Additional fields include the initial value, expiration date, deactivation timestamp (if applicable), and the associated Order if the gift card was purchased by a customer through checkout. Gift cards that merchants create manually won't have an associated order.

Anchor to idid •ID! required: The ID of the GiftCard to return.

Anchor to giftCardConfigurationgiftCardConfiguration

•GiftCardConfiguration!

non-null

The configuration for the shop's gift cards.

Anchor to giftCardsgiftCards

•GiftCardConnection!

non-null

Returns a paginated list of GiftCard objects issued for the shop.

You can filter gift cards by attributes such as status, last characters of the code, balance status, and other values using the query parameter. You can also apply SavedSearch objects to filter results.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•GiftCardSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document, including gift card codes.
Anchor to balance_status •string
Anchor to created_at •time
Anchor to expires_on •date
Anchor to id •id: Filter by id range.
Anchor to initial_value •string
Anchor to source •string
Anchor to status •string

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to giftCardsCountgiftCardsCount

•Count

The total number of gift cards issued for the shop. Limited to a maximum of 10000 by default.

Arguments

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document, including gift card codes.
Anchor to balance_status •string
Anchor to created_at •time
Anchor to expires_on •date
Anchor to id •id: Filter by id range.
Anchor to initial_value •string
Anchor to source •string
Anchor to status •string

Anchor to savedSearchIdsavedSearchId

•ID

The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to inventoryIteminventoryItem

•InventoryItem

Returns an InventoryItem object by ID.

Anchor to idid •ID! required: The ID of the InventoryItem to return.

Anchor to inventoryItemsinventoryItems

•InventoryItemConnection!

non-null

Returns a list of inventory items.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•InventoryTransferConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to sku •string: Filter by the inventory item sku field. Learn more about SKUs.
Anchor to updated_at •time

Anchor to inventoryLevelinventoryLevel

•InventoryLevel

Returns an InventoryLevel object by ID.

Anchor to idid •ID! required: The ID of the InventoryLevel to return.

Anchor to inventoryPropertiesinventoryProperties

•InventoryProperties!

non-null

Returns the shop's inventory configuration, including all inventory quantity names. Quantity names represent different inventory states that merchants use to track inventory.

Anchor to inventoryShipmentinventoryShipment

•InventoryShipment

Retrieves an InventoryShipment by ID. Returns tracking details, InventoryShipmentLineItem objects with quantities, and the shipment's current InventoryShipmentStatus.

Anchor to idid •ID! required: The ID of the inventory shipment.

Anchor to inventoryTransferinventoryTransfer

•InventoryTransfer

Returns an InventoryTransfer by ID. Inventory transfers track the movement of inventory between locations, including origin and destination details, InventoryTransferLineItem objects, quantities, and InventoryTransferStatus values.

Anchor to idid •ID! required: The ID of the inventory transfer.

Anchor to inventoryTransfersinventoryTransfers

non-null

Returns a paginated list of InventoryTransfer objects between locations. Transfers track the movement of InventoryItem objects between Location objects.

Supports filtering transfers using query parameters and sorting by various criteria. Use the connection's edges to access transfer details including InventoryTransferLineItem objects, quantities, and shipment status.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•TransferSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time
Anchor to destination_id •id
Anchor to id •id: Filter by id range.
Anchor to origin_id •id
Anchor to product_id •id
Anchor to product_variant_id •id
Anchor to source_id •id
Anchor to status •string
Anchor to tag •string: Filter objects by the tag field.
Anchor to tag_not •string: Filter by objects that don’t have the specified tag.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to jobjob

•Job

Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.

Anchor to idid •ID! required: ID of the job to query.

Anchor to locationlocation

•Location

Retrieves a Location by its ID. Locations are physical places where merchants store inventory, such as warehouses, retail stores, or fulfillment centers.

Each location tracks inventory levels, fulfillment capabilities, and address information. Active locations can stock products and fulfill orders based on their configuration settings.

Anchor to idid •ID: The ID of the location to return. If no ID is provided, the primary location of the Shop is returned.

Anchor to locationByIdentifierlocationByIdentifier

•Location

Return a location by an identifier.

Arguments

Anchor to identifieridentifier

•LocationIdentifierInput!

required

The identifier of the location.

Anchor to locationslocations

•LocationConnection!

non-null

A paginated list of inventory locations where merchants can stock Product items and fulfill Order items.

Returns only active locations by default. Use the includeInactive argument to retrieve deactivated locations that can no longer stock inventory or fulfill orders. Use the includeLegacy argument to include locations that FulfillmentService apps manage. Use the query argument to filter by location attributes like name, address, and whether local pickup is enabled.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•LocationSortKeys

Default:NAME

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to active •string
Anchor to address1 •string
Anchor to address2 •string
Anchor to city •string
Anchor to country •string
Anchor to created_at •time
Anchor to geolocated •boolean
Anchor to id •id: Filter by id range.
Anchor to legacy •boolean
Anchor to location_id •id
Anchor to name •string
Anchor to pickup_in_store •string
Anchor to province •string
Anchor to zip •string

Anchor to includeLegacyincludeLegacy

Default:false

Whether to include the legacy locations of fulfillment services.

Anchor to includeInactiveincludeInactive

Default:false

Whether to include the locations that are deactivated.

Anchor to locationsAvailableForDeliveryProfilesConnectionlocationsAvailableForDeliveryProfilesConnection

•LocationConnection!

non-null

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

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to locationsCountlocationsCount

•Count

Returns the count of locations for the given shop. Limited to a maximum of 10000 by default.

Arguments

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to active •string
Anchor to address1 •string
Anchor to address2 •string
Anchor to city •string
Anchor to country •string
Anchor to created_at •time
Anchor to geolocated •boolean
Anchor to id •id: Filter by id range.
Anchor to legacy •boolean
Anchor to location_id •id
Anchor to name •string
Anchor to pickup_in_store •string
Anchor to province •string
Anchor to zip •string

•FulfillmentOrderConnection!

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to manualHoldsFulfillmentOrdersmanualHoldsFulfillmentOrders

non-null

Returns a list of fulfillment orders that are on hold.

Anchor to queryquery •String: The query conditions used to filter fulfillment orders. Only fulfillment orders corresponding to orders matching the query will be counted. Supported filter parameters:

order_financial_status

order_risk_level

shipping_address_coordinates_validated

See the detailed search syntax for more information about using filters.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to marketmarket

•Market

Returns a Market resource by ID.

Anchor to idid •ID! required: The ID of the Market to return.

Anchor to marketingActivitiesmarketingActivities

•MarketingActivityConnection!

non-null

A list of marketing activities associated with the marketing app.

Arguments

Anchor to marketingActivityIdsmarketingActivityIds

•[ID!]

Default:[]

The list of marketing activity IDs to filter by.

Anchor to remoteIdsremoteIds

•[String!]

Default:[]

The list of remote IDs associated with marketing activities to filter by.

Anchor to utmutm

•UTMInput

The UTM parameters associated with marketing activities to filter by.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•MarketingActivitySortKeys

Default:CREATED_AT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to app_id •id
Anchor to app_name •string: A comma-separated list of app names.
Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to marketing_campaign_id •id
Anchor to scheduled_to_end_at •time
Anchor to scheduled_to_start_at •time
Anchor to tactic •string
Anchor to title •string
Anchor to updated_at •time

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to marketingActivitymarketingActivity

•MarketingActivity

Returns a MarketingActivity resource by ID.

Anchor to idid •ID! required: The ID of the MarketingActivity to return.

Anchor to marketingEventmarketingEvent

•MarketingEvent

Returns a MarketingEvent resource by ID.

Anchor to idid •ID! required: The ID of the MarketingEvent to return.

Anchor to marketingEventsmarketingEvents

•MarketingEventConnection!

non-null

A list of marketing events associated with the marketing app.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•MarketingEventSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•MarketLocalizableResourceConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to app_id •id
Anchor to description •string
Anchor to id •id: Filter by id range.
Anchor to started_at •time
Anchor to type •string

Anchor to marketLocalizableResourcemarketLocalizableResource

•MarketLocalizableResource

A resource that can have localized values for different markets.

Anchor to resourceIdresourceId •ID! required: Find a market localizable resource by ID.

Anchor to marketLocalizableResourcesmarketLocalizableResources

non-null

Resources that can have localized values for different markets.

Arguments

Anchor to resourceTyperesourceType

•MarketLocalizableResourceType!

required

Return only resources of a type.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

•MarketLocalizableResourceConnection!

Default:false

Reverse the order of the underlying list.

Anchor to marketLocalizableResourcesByIdsmarketLocalizableResourcesByIds

non-null

Resources that can have localized values for different markets.

Anchor to resourceIdsresourceIds •[ID!]! required: Return only resources for given IDs.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to marketsmarkets

•MarketConnection!

non-null

Returns a paginated list of Market objects configured for the shop. Markets match buyers based on defined conditions to deliver customized shopping experiences.

Filter markets by MarketType and MarketStatus, search by name, and control sort order. Retrieve market configurations including MarketCurrencySettings, MarketWebPresence objects, and MarketConditions.

Learn more about Shopify Markets.

Arguments

Anchor to enabledenabled

Default:null

Filters markets by enabled status.

•MarketType

Default:null

Filters markets by type.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•MarketsSortKeys

Default:NAME

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to id •id: Filter by id range.
Anchor to market_condition_types •string: A comma-separated list of condition types.
Anchor to market_type •string
Anchor to name •string
Anchor to status •string
Anchor to wildcard_company_location_with_country_code •string

Anchor to marketsResolvedValuesmarketsResolvedValues

•MarketsResolvedValues!

non-null

The resolved values for a buyer signal.

Arguments

Anchor to buyerSignalbuyerSignal

•BuyerSignalInput!

required

The buyer signal.

•Menu

Returns a Menu resource by ID.

Anchor to idid •ID! required: The ID of the Menu to return.

Anchor to menusmenus

•MenuConnection!

non-null

Retrieves navigation menus. Menus organize content into hierarchical navigation structures that merchants can display in the online store (for example, in headers, footers, and sidebars) and customer accounts.

Each Menu contains a handle for identification, a title for display, and a collection of MenuItem objects that can be nested up to 3 levels deep. Default menus have protected handles that can't be modified.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•MenuSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to id •id: Filter by id range.
Anchor to title •string

Anchor to menusCountmenusCount

•Count

Count of menus.

Arguments

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to id •id: Filter by id range.
Anchor to title •string

•MetafieldDefinitionIdentifierInput

•Int

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to metafieldDefinitionmetafieldDefinition

•MetafieldDefinition

Retrieves a MetafieldDefinition by its identifier. You can identify a definition using either its owner type, namespace, and key, or its global ID.

Use this query to inspect a definition's configuration, including its data type, validations, access settings, and the count of metafields using it.

Arguments

Anchor to idid

•ID

Deprecated

Anchor to identifieridentifier

The identifier of the MetafieldDefinition to return.

Anchor to metafieldDefinitionsmetafieldDefinitions

•MetafieldDefinitionConnection!

non-null

Returns a list of metafield definitions.

Arguments

Anchor to keykey

•String

Filter metafield definition by key.

Anchor to namespacenamespace

•String

Filter metafield definition by namespace.

Anchor to ownerTypeownerType

•MetafieldOwnerType!

required

Filter the metafield definition by the specific owner type.

Anchor to pinnedStatuspinnedStatus

•MetafieldDefinitionPinnedStatus

Default:ANY

Filter the metafield definition by the pinned status.

Anchor to constraintSubtypeconstraintSubtype

•MetafieldDefinitionConstraintSubtypeIdentifier

Filter metafield definitions based on whether they apply to a given resource subtype.

Anchor to constraintStatusconstraintStatus

•MetafieldDefinitionConstraintStatus

Filter metafield definitions based on whether they are constrained.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•MetafieldDefinitionSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•[MetafieldDefinitionType!]!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

Anchor to metafieldDefinitionTypesmetafieldDefinitionTypes

non-null

The available metafield types that you can use when creating MetafieldDefinition objects. Each type specifies what kind of data it stores (such as boolean, color, date, or references), its category, and which validations it supports.

For a list of supported types and their capabilities, refer to the metafield types documentation.

Anchor to metafieldsmetafields

•MetafieldConnection!

non-null

A paginated list of metafields.

Anchor to namespacenamespace •String: Filter metafields by namespace.
Anchor to ownerowner •ID! required: Filter metafields to a specific owner. Recommend using the metafields connection from HasMetafields directly from the owner instead.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to metaobjectmetaobject

•Metaobject

Retrieves a single Metaobject by its global ID. Metaobjects store custom structured data based on defined schemas. The returned metaobject includes its fields with values, display name, handle, and associated metadata like update timestamps and capabilities.

Anchor to idid •ID! required: The ID of the metaobject to return.

Anchor to metaobjectByHandlemetaobjectByHandle

•Metaobject

Retrieves a Metaobject by its handle and type. Handles are unique identifiers within a metaobject type.

Arguments

Anchor to handlehandle

•MetaobjectHandleInput!

required

The identifier of the metaobject to return.

Anchor to metaobjectDefinitionmetaobjectDefinition

•MetaobjectDefinition

Retrieves a MetaobjectDefinition by its global ID. Metaobject definitions provide the structure and fields for metaobjects.

The definition includes field configurations, access settings, display preferences, and capabilities that determine how metaobjects of this type behave across the Shopify platform.

Anchor to idid •ID! required: The ID of the metaobject to return.

Anchor to metaobjectDefinitionByTypemetaobjectDefinitionByType

•MetaobjectDefinition

Retrieves a MetaobjectDefinition by its type. The type serves as a unique identifier that distinguishes one metaobject definition from another.

Anchor to typetype •String! required: The type of the metaobject definition to return.

Anchor to metaobjectDefinitionsmetaobjectDefinitions

•MetaobjectDefinitionConnection!

non-null

Returns a paginated list of all MetaobjectDefinition objects configured for the store. Metaobject definitions provide the schema for creating custom data structures composed of individual fields. Each definition specifies the field types, access permissions, and capabilities for Metaobject entries of that type. Use this query to discover available metaobject types before creating or querying metaobject entries.

Learn more about managing metaobjects.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to metaobjectsmetaobjects

•MetaobjectConnection!

non-null

Returns a paginated list of Metaobject entries for a specific type. Metaobjects are custom data structures that extend Shopify's data model with merchant or app-specific data types.

Filter results using the query parameter with a search syntax for metaobject fields. Use fields.{key}:{value} to filter by field values, supporting any field previously marked as filterable. The sortKey parameter accepts id, type, updated_at, or display_name to control result ordering.

Learn more about querying metaobjects by field value.

Arguments

•String!

required

The type of the metaobjects to query.

•String

The key of a field to sort with. Supports "id", "type", "updated_at", and "display_name".

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•MobilePlatformApplicationConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to display_name •string
Anchor to fields.{key} •mixed: Filters metaobject entries by field value. Format: fields.{key}:{value}. Only fields marked as filterable in the metaobject definition can be used. Learn more about querying metaobjects by field value.
Anchor to handle •string
Anchor to id •id: Filter by id range.
Anchor to updated_at •time

Anchor to mobilePlatformApplicationmobilePlatformApplication

•MobilePlatformApplication

Return a mobile platform application by its ID.

Anchor to mobilePlatformApplicationsmobilePlatformApplications

non-null

List the mobile platform applications.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

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 idid •ID! required: The ID of the Node to return.

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 idsids •[ID!]! required: The IDs of the Nodes to return.

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:

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 idid •ID! required: The ID of the Order to return.

Anchor to orderByIdentifierorderByIdentifier

•Order

Return an order by an identifier.

Arguments

Anchor to identifieridentifier

•OrderIdentifierInput!

required

The identifier of the order.

Anchor to orderEditSessionorderEditSession

•OrderEditSession

Returns a OrderEditSession resource by ID.

Anchor to idid •ID! required: The ID of the OrderEditSession to return.

Anchor to orderPaymentStatusorderPaymentStatus

•OrderPaymentStatus

Retrieves the status of a deferred payment by its payment reference ID. Use this query to monitor the processing status of payments that are initiated through payment mutations. Deferred payments are called payment terms in the API.

The query returns an OrderPaymentStatus object that includes the current payment status, any error messages, and associated transactions. Poll this query to track asynchronous payment processing after initiating a deferred payment.

Anchor to paymentReferenceIdpaymentReferenceId •String! required: Unique identifier returned by orderCreatePayment.
Anchor to orderIdorderId •ID! required: ID of the order for which the payment was initiated.

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.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•OrderSortKeys

Default:PROCESSED_AT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to cart_token •string: Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order.
Anchor to channel •string: Filter by the channel information handle (ChannelInformation.channelDefinition.handle) field.
Anchor to channel_id •id: Filter by the channel id field.
Anchor to chargeback_status •string: Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution.
Anchor to checkout_token •string: Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order.
Anchor to confirmation_number •string: Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique.
Anchor to created_at •time: Filter by the date and time when the order was created in Shopify's system.
Anchor to credit_card_last4 •string: Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security.
Anchor to current_total_price •float: Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges.
Anchor to customer_id •id: Filter orders by the customer id field.
Anchor to delivery_method •string: Filter by the delivery methodType field.
Anchor to discount_code •string: Filter by the case-insensitive discount code that was applied to the order at checkout. Limited to the first discount code used on an order. Maximum characters: 255.
Anchor to email •string: Filter by the email address that's associated with the order to provide customer support or analyze purchasing patterns.
Anchor to financial_status •string: Filter by the order displayFinancialStatus field.
Anchor to fraud_protection_level •string: Filter by the level of fraud protection that's applied to the order. Use this filter to manage risk or handle disputes.
Anchor to fulfillment_location_id •id: Filter by the fulfillment location id (Fulfillment.location.id) field.
Anchor to fulfillment_status •string: Filter by the displayFulfillmentStatus field to prioritize shipments or monitor order processing.
Anchor to gateway •string: Filter by the paymentGatewayNames field. Use this filter to find orders that were processed through specific payment providers like Shopify Payments, PayPal, or other custom payment gateways.
Anchor to id •id: Filter by id range.
Anchor to location_id •id: Filter by the location id that's associated with the order to view and manage orders for specific locations. For POS orders, locations must be defined in the Shopify admin under Settings > Locations. If no ID is provided, then the primary location of the shop is returned.
Anchor to metafields.{namespace}.{key} •mixed: Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.
Anchor to name •string: Filter by the order name field.
Anchor to payment_id •string: Filter by the payment ID that's associated with the order to reconcile financial records or troubleshoot payment issues.
Anchor to payment_provider_id •id: Filter by the ID of the payment provider that's associated with the order to manage payment methods or troubleshoot transactions.
Anchor to po_number •string: Filter by the order poNumber field.
Anchor to processed_at •time: Filter by the order processedAt field.
Anchor to reference_location_id •id: Filter by the ID of a location that's associated with the order, such as locations from fulfillments, refunds, or the shop's primary location.
Anchor to return_status •string: Filter by the order's returnStatus to monitor returns processing and track which orders have active returns.
Anchor to risk_level •string: Filter by the order risk assessment riskLevel field.
Anchor to sales_channel •string: Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes.
Anchor to shipping_address_validation_result_summary •string: Filter by the validation status of the shipping address. Learn more about validating addresses.
Anchor to sku •string: Filter by the product variant sku field. Learn more about SKUs.
Anchor to source_identifier •string: Filter by the ID of the order placed on the originating platform, such as a unique POS or third-party identifier. This value doesn't correspond to the Shopify ID that's generated from a completed draft order.
Anchor to source_name •string: Filter by the platform where the order was placed to distinguish between web orders, POS sales, draft orders, or third-party channels. Use this filter to analyze sales performance across different ordering methods.
Anchor to status •string: Filter by the order's status to manage workflows or analyze the order lifecycle.
Anchor to subtotal_line_items_quantity •string: Filter by the total number of items across all line items in an order. This filter supports both exact values and ranges, and is useful for identifying bulk orders or analyzing purchase volume patterns.
Anchor to tag •string: Filter objects by the tag field.
Anchor to tag_not •string: Filter by objects that don’t have the specified tag.
Anchor to test •boolean: Filter by test orders. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled.
Anchor to total_weight •string: Filter by the order weight. This filter supports both exact values and ranges, and is to be used to filter orders by the total weight of all items (excluding packaging). It takes a unit of measurement as a suffix. It accepts the following units: g, kg, lb, oz.
Anchor to updated_at •time: Filter by the date and time when the order was last updated in Shopify's system.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to orderSavedSearchesorderSavedSearches

non-null

Returns saved searches for orders in the shop. Saved searches store search queries with their filters and search terms.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to ordersCountordersCount

•Count

Returns the number of orders in the shop. You can filter orders using search syntax or a SavedSearch, and set a maximum count limit to control query performance.

Use the query argument to filter the count by criteria like order status, financial state, or fulfillment status. The response includes both the count value and its precision, indicating whether the count is exact or an estimate.

Note

The count is limited to 10,000 orders by default. Use the limit argument to adjust this value, or pass null for no limit. Limited to a maximum of 10000 by default.

Arguments

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to cart_token •string: Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order.
Anchor to channel •string: Filter by the channel information handle (ChannelInformation.channelDefinition.handle) field.
Anchor to channel_id •id: Filter by the channel id field.
Anchor to chargeback_status •string: Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution.
Anchor to checkout_token •string: Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order.
Anchor to confirmation_number •string: Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique.
Anchor to created_at •time: Filter by the date and time when the order was created in Shopify's system.
Anchor to credit_card_last4 •string: Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security.
Anchor to current_total_price •float: Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges.
Anchor to customer_id •id: Filter orders by the customer id field.
Anchor to delivery_method •string: Filter by the delivery methodType field.
Anchor to discount_code •string: Filter by the case-insensitive discount code that was applied to the order at checkout. Limited to the first discount code used on an order. Maximum characters: 255.
Anchor to email •string: Filter by the email address that's associated with the order to provide customer support or analyze purchasing patterns.
Anchor to financial_status •string: Filter by the order displayFinancialStatus field.
Anchor to fraud_protection_level •string: Filter by the level of fraud protection that's applied to the order. Use this filter to manage risk or handle disputes.
Anchor to fulfillment_location_id •id: Filter by the fulfillment location id (Fulfillment.location.id) field.
Anchor to fulfillment_status •string: Filter by the displayFulfillmentStatus field to prioritize shipments or monitor order processing.
Anchor to gateway •string: Filter by the paymentGatewayNames field. Use this filter to find orders that were processed through specific payment providers like Shopify Payments, PayPal, or other custom payment gateways.
Anchor to id •id: Filter by id range.
Anchor to location_id •id: Filter by the location id that's associated with the order to view and manage orders for specific locations. For POS orders, locations must be defined in the Shopify admin under Settings > Locations. If no ID is provided, then the primary location of the shop is returned.
Anchor to metafields.{namespace}.{key} •mixed: Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.
Anchor to name •string: Filter by the order name field.
Anchor to payment_id •string: Filter by the payment ID that's associated with the order to reconcile financial records or troubleshoot payment issues.
Anchor to payment_provider_id •id: Filter by the ID of the payment provider that's associated with the order to manage payment methods or troubleshoot transactions.
Anchor to po_number •string: Filter by the order poNumber field.
Anchor to processed_at •time: Filter by the order processedAt field.
Anchor to reference_location_id •id: Filter by the ID of a location that's associated with the order, such as locations from fulfillments, refunds, or the shop's primary location.
Anchor to return_status •string: Filter by the order's returnStatus to monitor returns processing and track which orders have active returns.
Anchor to risk_level •string: Filter by the order risk assessment riskLevel field.
Anchor to sales_channel •string: Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes.
Anchor to shipping_address_validation_result_summary •string: Filter by the validation status of the shipping address. Learn more about validating addresses.
Anchor to sku •string: Filter by the product variant sku field. Learn more about SKUs.
Anchor to source_identifier •string: Filter by the ID of the order placed on the originating platform, such as a unique POS or third-party identifier. This value doesn't correspond to the Shopify ID that's generated from a completed draft order.
Anchor to source_name •string: Filter by the platform where the order was placed to distinguish between web orders, POS sales, draft orders, or third-party channels. Use this filter to analyze sales performance across different ordering methods.
Anchor to status •string: Filter by the order's status to manage workflows or analyze the order lifecycle.
Anchor to subtotal_line_items_quantity •string: Filter by the total number of items across all line items in an order. This filter supports both exact values and ranges, and is useful for identifying bulk orders or analyzing purchase volume patterns.
Anchor to tag •string: Filter objects by the tag field.
Anchor to tag_not •string: Filter by objects that don’t have the specified tag.
Anchor to test •boolean: Filter by test orders. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled.
Anchor to total_weight •string: Filter by the order weight. This filter supports both exact values and ranges, and is to be used to filter orders by the total weight of all items (excluding packaging). It takes a unit of measurement as a suffix. It accepts the following units: g, kg, lb, oz.
Anchor to updated_at •time: Filter by the date and time when the order was last updated in Shopify's system.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to pagepage

•Page

Returns a Page resource by ID.

Anchor to idid •ID! required: The ID of the Page to return.

Anchor to pagespages

•PageConnection!

non-null

A paginated list of pages from the online store. Page objects are content pages that merchants create to provide information to customers, such as "About Us", "Contact", or policy pages.

The query supports filtering with a search query and sorting by various criteria. Advanced filtering is available through saved searches using the savedSearchId argument.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•PageSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•PaymentCustomizationConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the page was created.
Anchor to handle •string: Filter by the handle of the page.
Anchor to id •id: Filter by id range.
Anchor to published_at •time: Filter by the date and time when the page was published.
Anchor to published_status •string: Filter by published status
Anchor to title •string: Filter by the title of the page.
Anchor to updated_at •time: Filter by the date and time when the page was last updated.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to pagesCountpagesCount

•Count

Count of pages. Limited to a maximum of 10000 by default.

Anchor to limitlimit •Int Default:10000: The upper bound on count value before returning a result. Use null to have no limit.

Anchor to paymentCustomizationpaymentCustomization

•PaymentCustomization

The payment customization.

Anchor to idid •ID! required: The ID of the payment customization.

Anchor to paymentCustomizationspaymentCustomizations

non-null

The payment customizations.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•PerformanceAggregationLevel

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to enabled •boolean
Anchor to function_id •string
Anchor to id •id: Filter by id range.

Anchor to paymentTermsTemplatespaymentTermsTemplates

•[PaymentTermsTemplate!]!

non-null

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

Arguments

Anchor to paymentTermsTypepaymentTermsType

•PaymentTermsType

The payment terms type to filter the payment terms templates list.

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 maxDaysmaxDays •Int Default:90: Filters the RUM (Real User Monitoring) events for those created within the specified period.

Anchor to performanceMetricsperformanceMetrics

•[PerformanceMetrics!]

RUM (Real User Monitoring) performance metrics for a shop.

Arguments

Anchor to aggregationLevelaggregationLevel

Default:DAILY

Fetches RUM (Real User Monitoring) data for the specified aggregation level.

Anchor to deviceTypesdeviceTypes

•[PerformanceDeviceType!]

Default:[ALL]

Fetches RUM (Real User Monitoring) data for the specified device type.

Anchor to maxDaysmaxDays

•Int

Default:90

Filters RUM (Real User Monitoring) data within the specified period.

Anchor to storefrontIdstorefrontId

•String

Specifies the storefront to return RUM (Real User Monitoring) data for. Can be a Hydrogen storefront ID (e.g. 1234) or online_store (defaults to online_store).

Anchor to pointOfSaleDevicepointOfSaleDevice

•PointOfSaleDevice

Returns a PointOfSaleDevice resource by ID.

Anchor to idid •ID! required: The ID of the PointOfSaleDevice to return.

Anchor to priceListpriceList

•PriceList

Returns a PriceList by ID. You can use price lists to specify either fixed prices or adjusted relative prices that override initial Product prices.

Price lists enable contextual pricing for the Catalog they are associated to. Each price list can define fixed prices for specific ProductVariant objects or percentage-based adjustments relative to other prices.

Anchor to idid •ID! required: The ID of the PriceList to return.

Anchor to priceListspriceLists

•PriceListConnection!

non-null

All price lists for a shop.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•PriceListSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

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 idid •ID! required: The ID of the Product to return.

Anchor to productByIdentifierproductByIdentifier

•Product

Return a product by an identifier.

Arguments

Anchor to identifieridentifier

•ProductIdentifierInput!

required

The identifier of the product.

Anchor to productDuplicateJobproductDuplicateJob

•ProductDuplicateJob!

non-null

Returns the product duplicate job.

Anchor to idid •ID! required: An ID of a product duplicate job to fetch.

Anchor to productFeedproductFeed

•ProductFeed

Returns a ProductFeed resource by ID.

Anchor to idid •ID! required: The ID of the ProductFeed to return.

Anchor to productFeedsproductFeeds

•ProductFeedConnection!

non-null

The product feeds for the shop.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

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 idid •ID! required: The ID of the ProductOperation to return.

Anchor to productResourceFeedbackproductResourceFeedback

•ProductResourceFeedback

Retrieves product resource feedback for the currently authenticated app, providing insights into product data quality, completeness, and optimization opportunities. This feedback helps apps guide merchants toward better product listings and improved store performance.

For example, an SEO app might receive feedback indicating that certain products lack meta descriptions or have suboptimal titles, enabling the app to provide specific recommendations for improving search visibility and conversion rates.

Use ProductResourceFeedback to:

Display product optimization recommendations to merchants
Identify data quality issues across product catalogs
Build product improvement workflows and guided experiences
Track progress on product listing completeness and quality
Implement automated product auditing and scoring systems
Generate reports on catalog health and optimization opportunities
Provide contextual suggestions within product editing interfaces

The feedback system evaluates products against various criteria including SEO best practices, required fields, media quality, and sales channel requirements. Each feedback item includes specific details about the issue, suggested improvements, and priority levels.

Feedback is app-specific and reflects the particular focus of your application - marketing apps receive different insights than inventory management apps. The system continuously updates as merchants make changes, providing real-time guidance for product optimization.

This resource is particularly valuable for apps that help merchants improve their product listings, optimize for search engines, or enhance their overall catalog quality. The feedback enables proactive suggestions rather than reactive problem-solving.

Learn more about product optimization.

Anchor to idid •ID! required: The product associated with the resource feedback.

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.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•ProductSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to barcode •string: Filter by the product variant barcode field.
Anchor to bundles •boolean: Filter by a product bundle. A product bundle is a set of two or more related products, which are commonly offered at a discount.
Anchor to category_id •string: Filter by the product category ID (product.category.id). A product category is the category of a product from Shopify's Standard Product Taxonomy.
Anchor to collection_id •id: Filter by the collection id field.
Anchor to combined_listing_role •string: Filter by the role of the product in a combined listing.
Anchor to created_at •time: Filter by the date and time when the product was created.
Anchor to delivery_profile_id •id: Filter by the delivery profile id field.
Anchor to error_feedback •string: Filter by products with publishing errors.
Anchor to gift_card •boolean: Filter by the product isGiftCard field.
Anchor to handle •string: Filter by a comma-separated list of product handles.
Anchor to has_only_composites •boolean: Filter by products that have only composite variants.
Anchor to has_only_default_variant •boolean: Filter by products that have only a default variant. A default variant is the only variant if no other variants are specified.
Anchor to has_variant_with_components •boolean: Filter by products that have variants with associated components.
Anchor to id •id: Filter by id range.
Anchor to inventory_total •integer: Filter by inventory count.
Anchor to is_price_reduced •boolean: Filter by products that have a reduced price. For more information, refer to the CollectionRule object.
Anchor to metafields.{namespace}.{key} •mixed: Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.
Anchor to out_of_stock_somewhere •boolean: Filter by products that are out of stock in at least one location.
Anchor to price •bigdecimal: Filter by the product variant price field.
Anchor to product_configuration_owner •string: Filter by the app id field.
Anchor to product_publication_status •string: Filter by channel approval process status of the resource on a channel, such as the online store. The value is a composite of the channel app ID (Channel.app.id) and one of the valid values. For simple visibility checks, use published_status instead.
Anchor to product_type •string: Filter by a comma-separated list of product types.
Anchor to publication_ids •string: Filter by a comma-separated list of publication IDs that are associated with the product.
Anchor to publishable_status •string: Deprecated: This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use published_status for visibility checks. Filter by the publishable status of the resource on a channel. The value is a composite of the channel app ID (Channel.app.id) and one of the valid status values.
Anchor to published_at •time: Filter by the date and time when the product was published to the online store and other sales channels.
Anchor to published_status •string: Filter resources by their visibility and publication state on a channel. Online store channel filtering: - online_store_channel: Returns all resources in the online store channel, regardless of publication status. - published/visible: Returns resources that are published to the online store. - unpublished: Returns resources that are not published to the online store. Channel-specific filtering using the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel.
Anchor to sku •string: Filter by the product variant sku field. Learn more about SKUs.
Anchor to status •string: Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps.
Anchor to tag •string: Filter objects by the tag field.
Anchor to tag_not •string: Filter by objects that don’t have the specified tag.
Anchor to title •string: Filter by the product title field.
Anchor to updated_at •time: Filter by the date and time when the product was last updated.
Anchor to variant_id •id: Filter by the product variant id field.
Anchor to variant_title •string: Filter by the product variant title field.
Anchor to vendor •string: Filter by the origin or source of the product. Learn more about vendors and managing vendor information.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to productSavedSearchesproductSavedSearches

non-null

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

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to productsCountproductsCount

•Count

Count of products. Limited to a maximum of 10000 by default.

Arguments

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to barcode •string: Filter by the product variant barcode field.
Anchor to bundles •boolean: Filter by a product bundle. A product bundle is a set of two or more related products, which are commonly offered at a discount.
Anchor to category_id •string: Filter by the product category ID (product.category.id). A product category is the category of a product from Shopify's Standard Product Taxonomy.
Anchor to collection_id •id: Filter by the collection id field.
Anchor to combined_listing_role •string: Filter by the role of the product in a combined listing.
Anchor to created_at •time: Filter by the date and time when the product was created.
Anchor to delivery_profile_id •id: Filter by the delivery profile id field.
Anchor to error_feedback •string: Filter by products with publishing errors.
Anchor to gift_card •boolean: Filter by the product isGiftCard field.
Anchor to handle •string: Filter by a comma-separated list of product handles.
Anchor to has_only_composites •boolean: Filter by products that have only composite variants.
Anchor to has_only_default_variant •boolean: Filter by products that have only a default variant. A default variant is the only variant if no other variants are specified.
Anchor to has_variant_with_components •boolean: Filter by products that have variants with associated components.
Anchor to id •id: Filter by id range.
Anchor to inventory_total •integer: Filter by inventory count.
Anchor to is_price_reduced •boolean: Filter by products that have a reduced price. For more information, refer to the CollectionRule object.
Anchor to metafields.{namespace}.{key} •mixed: Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.
Anchor to out_of_stock_somewhere •boolean: Filter by products that are out of stock in at least one location.
Anchor to price •bigdecimal: Filter by the product variant price field.
Anchor to product_configuration_owner •string: Filter by the app id field.
Anchor to product_publication_status •string: Filter by channel approval process status of the resource on a channel, such as the online store. The value is a composite of the channel app ID (Channel.app.id) and one of the valid values. For simple visibility checks, use published_status instead.
Anchor to product_type •string: Filter by a comma-separated list of product types.
Anchor to publication_ids •string: Filter by a comma-separated list of publication IDs that are associated with the product.
Anchor to publishable_status •string: Deprecated: This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use published_status for visibility checks. Filter by the publishable status of the resource on a channel. The value is a composite of the channel app ID (Channel.app.id) and one of the valid status values.
Anchor to published_at •time: Filter by the date and time when the product was published to the online store and other sales channels.
Anchor to published_status •string: Filter resources by their visibility and publication state on a channel. Online store channel filtering: - online_store_channel: Returns all resources in the online store channel, regardless of publication status. - published/visible: Returns resources that are published to the online store. - unpublished: Returns resources that are not published to the online store. Channel-specific filtering using the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel.
Anchor to sku •string: Filter by the product variant sku field. Learn more about SKUs.
Anchor to status •string: Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps.
Anchor to tag •string: Filter objects by the tag field.
Anchor to tag_not •string: Filter by objects that don’t have the specified tag.
Anchor to title •string: Filter by the product title field.
Anchor to updated_at •time: Filter by the date and time when the product was last updated.
Anchor to variant_id •id: Filter by the product variant id field.
Anchor to variant_title •string: Filter by the product variant title field.
Anchor to vendor •string: Filter by the origin or source of the product. Learn more about vendors and managing vendor information.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.

•ProductVariantIdentifierInput!

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to productTagsproductTags

•StringConnection

Returns tags added to Product objects in the shop. Provides a paginated list of tag strings.

The maximum page size is 5000 tags per request. Tags are returned as simple strings through a StringConnection. The maximum page size is 5000.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to productTypesproductTypes

•StringConnection

Returns a paginated list of product types assigned to products in the store. The maximum page size is 1000. The maximum page size is 1000.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

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 idid •ID! required: The ID of the ProductVariant to return.

Anchor to productVariantByIdentifierproductVariantByIdentifier

•ProductVariant

Return a product variant by an identifier.

Arguments

Anchor to identifieridentifier

required

The identifier of the product variant.

Anchor to productVariantsproductVariants

•ProductVariantConnection!

non-null

Retrieves a list of product variants associated with a product.

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.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•ProductVariantSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to barcode •string: Filter by the product variant barcode field.
Anchor to collection •string: Filter by the ID of the collection that the product variant belongs to.
Anchor to delivery_profile_id •id: Filter by the product variant delivery profile ID (ProductVariant.deliveryProfile.id).
Anchor to exclude_composite •boolean: Filter by product variants that aren't composites.
Anchor to exclude_variants_with_components •boolean: Filter by whether there are components that are associated with the product variants in a bundle.
Anchor to gift_card •boolean: Filter by the product isGiftCard field.
Anchor to id •id: Filter by id range.
Anchor to inventory_quantity •integer: Filter by an aggregate of inventory across all locations where the product variant is stocked.
Anchor to location_id •id: Filter by the location ID for the product variant.
Anchor to managed •boolean: Filter by whether there is fulfillment service tracking associated with the product variants.
Anchor to managed_by •string: Filter by the fulfillment service that tracks the number of items in stock for the product variant.
Anchor to option1 •string: Filter by a custom property that a shop owner uses to define product variants.
Anchor to option2 •string: Filter by a custom property that a shop owner uses to define product variants.
Anchor to option3 •string: Filter by a custom property that a shop owner uses to define product variants.
Anchor to product_id •id: Filter by the product id field.
Anchor to product_ids •string: Filter by a comma-separated list of product IDs.
Anchor to product_publication_status •string: Filter by channel approval process status of the resource on a channel, such as the online store. The value is a composite of the channel app ID (Channel.app.id) and one of the valid values. For simple visibility checks, use published_status instead.
Anchor to product_status •string: Filter by a comma-separated list of product statuses.
Anchor to product_type •string: Filter by the product type that's associated with the product variants.
Anchor to publishable_status •string: Deprecated: This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use published_status for visibility checks. Filter by the publishable status of the resource on a channel. The value is a composite of the channel app ID (Channel.app.id) and one of the valid status values.
Anchor to published_status •string: Filter resources by their visibility and publication state on a channel. Online store channel filtering: - online_store_channel: Returns all resources in the online store channel, regardless of publication status. - published/visible: Returns resources that are published to the online store. - unpublished: Returns resources that are not published to the online store. Channel-specific filtering using the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel.
Anchor to requires_components •boolean: Filter by whether the product variant can only be purchased with components. Learn more.
Anchor to sku •string: Filter by the product variant sku field. Learn more about SKUs.
Anchor to tag •string: Filter objects by the tag field.
Anchor to tag_not •string: Filter by objects that don’t have the specified tag.
Anchor to taxable •boolean: Filter by the product variant taxable field.
Anchor to title •string: Filter by the product variant title field.
Anchor to updated_at •time: Filter by date and time when the product variant was updated.
Anchor to vendor •string: Filter by the origin or source of the product variant. Learn more about vendors and managing vendor information.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to productVariantsCountproductVariantsCount

•Count

Count of product variants. Limited to a maximum of 10000 by default.

Anchor to queryquery •String: No supported search fields.
Anchor to limitlimit •Int Default:10000: The upper bound on count value before returning a result. Use null to have no limit.

Anchor to productVendorsproductVendors

•StringConnection

The list of vendors added to products. The maximum page size is 1000.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

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

Retrieves a Publication by ID.

Returns null if the publication doesn't exist.

Anchor to idid •ID! required: The ID of the Publication to return.

Anchor to publicationspublications

•PublicationConnection!

non-null

Returns a paginated list of Publication.

Filter publications by CatalogType.

Arguments

Anchor to catalogTypecatalogType

Filter publications by catalog type.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Anchor to publicationsCountpublicationsCount

•Count

Count of publications. Limited to a maximum of 10000 by default.

Arguments

Anchor to catalogTypecatalogType

Filter publications by catalog type.

•ReturnableFulfillmentConnection!

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to publishedProductsCountpublishedProductsCount

•Count

Returns a count of published products by publication ID. Limited to a maximum of 10000 by default.

Anchor to publicationIdpublicationId •ID! required: The ID of the publication that the products are published to.
Anchor to limitlimit •Int Default:10000: The maximum number of products to count.

Anchor to refundrefund

•Refund

Retrieves a refund by its ID. A refund represents a financial record of money returned to a customer from an order. It provides a comprehensive view of all refunded amounts, transactions, and restocking instructions associated with returning products or correcting order issues.

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

Displaying refund details in order management interfaces
Building customer service tools for reviewing refund history
Creating reports on refunded amounts and reasons
Auditing refund transactions and payment gateway records
Tracking inventory impacts from refunded items

A refund is associated with an order and includes refund line items that specify which items were refunded. Each refund processes through order transactions that handle the actual money transfer back to the customer.

Anchor to idid •ID! required: The ID of the Refund to return.

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:

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 idid •ID! required: The globally-unique ID of the return to retrieve.

Anchor to returnableFulfillmentreturnableFulfillment

•ReturnableFulfillment

Returns a ReturnableFulfillment resource by ID.

Anchor to idid •ID! required: The ID of the ReturnableFulfillment to return.

Anchor to returnableFulfillmentsreturnableFulfillments

non-null

List of returnable fulfillments.

Anchor to orderIdorderId •ID! required: Order ID that will scope all returnable fulfillments.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to returnCalculatereturnCalculate

•CalculatedReturn

Calculates the financial outcome of a Return without creating it. Use this query to preview return costs before initiating the actual return process.

The calculation provides detailed breakdowns of refund amounts, taxes, RestockingFee charges, return shipping fees, and order-level discount adjustments based on the FulfillmentLineItem objects that customers select for return.

Learn more about building for return management.

Arguments

Anchor to inputinput

•CalculateReturnInput!

required

The input fields for calculating a return.

Anchor to returnReasonDefinitionsreturnReasonDefinitions

•ReturnReasonDefinitionConnection!

non-null

Returns the full library of available return reason definitions.

Use this query to retrieve the standardized return reasons available for creating returns. Filter by IDs or handles to get specific definitions.

Only non-deleted reasons should be shown to customers when creating new returns. Deleted reasons have been replaced with better alternatives and are no longer recommended. However, they remain valid options and may still appear on existing returns.

Arguments

Anchor to idsids

•[ID!]

A list of return reason definition IDs to filter by.

Anchor to handleshandles

•[String!]

A list of return reason definition handles to filter by.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•ReturnReasonDefinitionSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to deleted •boolean: Filter by whether the return reason has been removed from taxonomy.
Anchor to id •id: Filter by id range.
Anchor to name •string: Filter by name.

Anchor to reverseDeliveryreverseDelivery

•ReverseDelivery

Lookup a reverse delivery by ID.

Anchor to idid •ID! required: The ID of the ReverseDelivery to return.

Anchor to reverseFulfillmentOrderreverseFulfillmentOrder

•ReverseFulfillmentOrder

Lookup a reverse fulfillment order by ID.

Anchor to idid •ID! required: The ID of the reverse fulfillment order to return.

Anchor to scriptTagscriptTag

•ScriptTag

Theme app extensions

If your app integrates with a Shopify theme and you plan to submit it to the Shopify App Store, you must use theme app extensions instead of Script tags. Script tags can only be used with 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.

Returns a ScriptTag resource by ID.

Anchor to idid •ID! required: The ID of the ScriptTag to return.

Anchor to scriptTagsscriptTags

•ScriptTagConnection!

non-null

Theme app extensions

Script tag deprecation

A list of script tags.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•SegmentMigrationConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to src •string
Anchor to updated_at •time

Anchor to srcsrc

•URL

The source URL of the script tag to filter by.

Anchor to segmentsegment

•Segment

Retrieves a customer Segment by ID. Segments are dynamic groups of customers that meet specific criteria defined through ShopifyQL queries.

Use segments for targeted marketing campaigns, analyzing customer behavior, or creating personalized experiences. Each segment includes its name, creation date, and the query that defines which Customer objects belong to it.

Anchor to idid •ID! required: Find a segment by ID.

Anchor to segmentFilterssegmentFilters

•SegmentFilterConnection!

non-null

A list of filters.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.

Anchor to segmentFilterSuggestionssegmentFilterSuggestions

•SegmentFilterConnection!

non-null

A list of filter suggestions associated with a segment. A segment is a group of members (commonly customers) that meet specific criteria.

Anchor to searchsearch •String! required: Returns the elements of a list by keyword or term.
Anchor to firstfirst •Int! required: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.

Anchor to segmentMigrationssegmentMigrations

non-null

A list of a shop's segment migrations.

Anchor to savedSearchIdsavedSearchId •ID: Search a segment migration by its saved search ID.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.

Anchor to segmentssegments

•SegmentConnection!

non-null

Returns a paginated list of Segment objects for the shop. Segments are dynamic groups of customers that meet specific criteria defined through ShopifyQL queries. You can filter segments by search query and sort them by creation date or other criteria.

The query supports standard pagination arguments and returns a SegmentConnection containing segment details including names, creation dates, and the query definitions that determine segment membership.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•SegmentSortKeys

Default:CREATION_DATE

Sort the underlying list by the given key.

•SellingPlanGroupConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to id •id: Filter by id range.
Anchor to name •string

Anchor to segmentsCountsegmentsCount

•Count

The number of segments for a shop. Limited to a maximum of 10000 by default.

Anchor to limitlimit •Int Default:10000: The upper bound on count value before returning a result. Use null to have no limit.

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 searchsearch •String! required: Returns the elements of a list by keyword or term.
Anchor to filterQueryNamefilterQueryName •String: Returns the elements of a list by filter handle.
Anchor to functionParameterQueryNamefunctionParameterQueryName •String: Returns the elements of a list by filter parameter name.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.

Anchor to sellingPlanGroupsellingPlanGroup

•SellingPlanGroup

Returns a SellingPlanGroup resource by ID.

Anchor to idid •ID! required: The ID of the SellingPlanGroup to return.

Anchor to sellingPlanGroupssellingPlanGroups

non-null

Retrieves a paginated list of SellingPlanGroup objects that belong to the app making the API call. Selling plan groups are selling methods like subscriptions, preorders, or other purchase options that merchants offer to customers.

Each group has one or more SellingPlan objects that define specific billing and delivery schedules, pricing adjustments, and policies. Use the query argument to search by name or filter results by other criteria.

Learn more about building selling plans.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•SellingPlanGroupSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•ShopPayPaymentRequestReceipt

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to app_id •id
Anchor to category •string: A comma-separated list of categories.
Anchor to created_at •time
Anchor to delivery_frequency •string
Anchor to id •id: Filter by id range.
Anchor to name •string
Anchor to percentage_off •float

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, including the currency for paying for apps and services. Use this to create app charges in the merchant's local billing currency, helping them budget their app spend without exposure to exchange rate fluctuations.

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 idid •String! required: The ID of the Shopify Function.

Anchor to shopifyFunctionsshopifyFunctions

•ShopifyFunctionConnection!

non-null

Returns Shopify Functions owned by the querying API client installed on the shop. Functions enable you to customize Shopify's backend logic at specific points in the commerce loop, such as discounts, checkout validation, and fulfillment.

You can filter the results by API type to find specific function implementations, or by whether they provide a merchant configuration interface in the Shopify Admin.

The response includes details about each function's configuration, including its title, description, API version, and the input query used to provide data to the function logic.

Learn more about building functions.

Anchor to apiTypeapiType •String: Filter the functions by the API type.
Anchor to useCreationUiuseCreationUi •Boolean: Filter the functions by whether or not the function uses the creation UI in the Admin.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to shopifyPaymentsAccountshopifyPaymentsAccount

•ShopifyPaymentsAccount

Returns the Shopify Payments account information for the shop. Includes current balances across all currencies, payout schedules, and bank account configurations.

The account includes ShopifyPaymentsBalanceTransaction records showing charges, refunds, and adjustments that affect your balance. Also includes ShopifyPaymentsDispute records and ShopifyPaymentsPayout history between the account and connected ShopifyPaymentsBankAccount configurations.

Anchor to shopifyqlQueryshopifyqlQuery

•ShopifyqlQueryResponse

Executes a ShopifyQL query to analyze store data and returns results in a tabular format.

The response includes column metadata with names, data types, and display names, along with the actual data rows. If the query contains syntax errors, then the response provides parse error messages instead of table data.

Read the ShopifyQL reference documentation for more information on how to write ShopifyQL queries.

Anchor to queryquery •String! required: A ShopifyQL query string following the ShopifyQL syntax. Queries must include FROM to specify the data source (such as sales, orders, or customers) and SHOW to select metrics and dimensions. Example: FROM sales SHOW total_sales TIMESERIES month SINCE -12m.

Anchor to shopLocalesshopLocales

•[ShopLocale!]!

non-null

Returns the locales enabled on a shop. Each locale represents a language for translations and determines how content displays to customers in different markets.

Use the optional published argument to filter for only the locales that are visible to customers. The response includes the ISO locale code, whether it's the shop's primary locale, and which MarketWebPresence objects use each locale.

Anchor to publishedpublished •Boolean Default:false: Return only published locales.

Anchor to shopPayPaymentRequestReceiptshopPayPaymentRequestReceipt

Returns a Shop Pay payment request receipt.

Anchor to tokentoken •String! required: Unique identifier of the payment request receipt.

Anchor to shopPayPaymentRequestReceiptsshopPayPaymentRequestReceipts

•ShopPayPaymentRequestReceiptConnection

Returns a list of Shop Pay payment request receipts.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•ShopPayPaymentRequestReceiptsSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to created_at •time: Filter by the creation date of the payment request receipt.
Anchor to id •id: Filter by id range.
Anchor to source_identifier •string: Filter by the source identifier of the payment request receipt.
Anchor to state •string: Filter by the state of the payment request receipt. Options include: - COMPLETED - FAILED - PENDING - PROCESSING

Anchor to staffMemberstaffMember

•StaffMember

Retrieves a staff member by ID. If no ID is provided, the query returns the staff member that's making the request. A staff member is a user who can access the Shopify admin to manage store operations.

Provides staff member details such as email, name, and shop owner status. When querying the current user (with or without an ID), additional private data becomes available.

Anchor to idid •ID: The ID of the staff member to return. If no ID is provided, then the staff member making the query (if any) is returned.

Anchor to staffMembersstaffMembers

•StaffMemberConnection

Returns a paginated list of StaffMember objects for the shop. Staff members are users who can access the Shopify admin to manage store operations.

Supports filtering by account type, email, and name, with an option to sort results. The query returns a StaffMemberConnection for cursor-based pagination.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•StaffMembersSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•StandardMetafieldDefinitionTemplateConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to account_type •string: Filter by account type.
Anchor to email •string: Filter by email.
Anchor to first_name •string: Filter by first name.
Anchor to id •id: Filter by id range.
Anchor to last_name •string: Filter by last name.

Anchor to standardMetafieldDefinitionTemplatesstandardMetafieldDefinitionTemplates

non-null

Retrieves preset metafield definition templates for common use cases. Each template provides a reserved namespace and key combination for specific purposes like product subtitles, care guides, or ISBN numbers. Use these templates to create standardized metafields across your store. Filter templates by constraint status or exclude those you've already activated.

See the list of standard metafield definitions for available templates.

Arguments

Anchor to constraintSubtypeconstraintSubtype

•MetafieldDefinitionConstraintSubtypeIdentifier

Filter standard metafield definitions based on whether they apply to a given resource subtype.

Anchor to constraintStatusconstraintStatus

•MetafieldDefinitionConstraintStatus

Filter standard metafield definitions based on whether they are constrained.

Anchor to excludeActivatedexcludeActivated

Default:false

Filter standard metafield definitions that have already been activated.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

•SubscriptionBillingAttemptConnection!

Default:false

Reverse the order of the underlying list.

Anchor to storeCreditAccountstoreCreditAccount

•StoreCreditAccount

Retrieves a StoreCreditAccount by ID. Store credit accounts hold monetary balances that account owners can use at checkout. The owner is either a Customer or a CompanyLocation.

Anchor to idid •ID! required: The ID of the store credit account to return.

Anchor to subscriptionBillingAttemptsubscriptionBillingAttempt

•SubscriptionBillingAttempt

Returns a SubscriptionBillingAttempt resource by ID.

Anchor to idid •ID! required: The ID of the SubscriptionBillingAttempt to return.

Anchor to subscriptionBillingAttemptssubscriptionBillingAttempts

non-null

Returns subscription billing attempts on a store.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•SubscriptionBillingAttemptsSortKeys

Default:CREATED_AT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•SubscriptionBillingCycleInput!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to created_at •time
Anchor to error_code •string
Anchor to error_message •string
Anchor to id •id: Filter by id range.

Anchor to subscriptionBillingCyclesubscriptionBillingCycle

•SubscriptionBillingCycle

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

Arguments

Anchor to billingCycleInputbillingCycleInput

required

Input object used to select and use billing cycles.

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 jobIdjobId •ID! required: The ID of the billing cycle bulk operation job.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to subscriptionBillingCyclessubscriptionBillingCycles

•SubscriptionBillingCycleConnection!

non-null

Returns subscription billing cycles for a contract ID.

Arguments

Anchor to contractIdcontractId

•ID!

required

The ID of the subscription contract to retrieve billing cycles for.

Anchor to billingCyclesDateRangeSelectorbillingCyclesDateRangeSelector

•SubscriptionBillingCyclesDateRangeSelector

Select subscription billing cycles within a date range.

Anchor to billingCyclesIndexRangeSelectorbillingCyclesIndexRangeSelector

•SubscriptionBillingCyclesIndexRangeSelector

Select subscription billing cycles within an index range.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•SubscriptionBillingCyclesSortKeys

Default:CYCLE_INDEX

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to subscriptionContractsubscriptionContract

•SubscriptionContract

Retrieves a SubscriptionContract by ID.

The contract tracks the subscription's lifecycle through various statuses, and links to related billing attempts, generated Order objects, and the customer's CustomerPaymentMethod.

Anchor to idid •ID! required: The ID of the Subscription Contract to return.

Anchor to subscriptionContractssubscriptionContracts

•SubscriptionContractConnection!

non-null

Returns a SubscriptionContractConnection containing subscription contracts. Subscription contracts are agreements between customers and merchants for recurring purchases with defined billing and delivery schedules.

Filter results with the query argument. You can paginate results using standard cursor-based pagination.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•SubscriptionContractsSortKeys

Default:CREATED_AT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•[SubscriptionMigrationGateway!]!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to last_billing_attempt_error_type •string
Anchor to status •string
Anchor to updated_at •time

Anchor to subscriptionDraftsubscriptionDraft

•SubscriptionDraft

Returns a Subscription Draft resource by ID.

Anchor to idid •ID! required: The ID of the Subscription Draft to return.

Anchor to subscriptionGatewaysubscriptionGateway

•SubscriptionGateway

Gateway used for subscription charges.

Anchor to subscriptionMigrationGatewayssubscriptionMigrationGateways

non-null

The list of payment gateways that can be used for subscription contract migrations.

Anchor to taxonomytaxonomy

•Taxonomy

Access to Shopify's standardized product taxonomy for categorizing products. The Taxonomy organizes products into a hierarchical tree structure with categories, attributes, and values.

Query categories using search terms, or navigate the hierarchy by requesting children, siblings, or descendants of specific categories. Each TaxonomyCategory includes its position in the tree, parent-child relationships, and associated attributes for that product category.

Anchor to tenderTransactionstenderTransactions

•TenderTransactionConnection!

non-null

Transactions representing a movement of money between customers and the shop. Each transaction records the amount, payment method, processing details, and the associated Order.

Positive amounts indicate customer payments to the merchant. Negative amounts represent refunds from the merchant to the customer. Use the query parameter to filter transactions by attributes such as transaction ID, processing date, and point-of-sale device ID.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to id •id: Filter by id range.
Anchor to point_of_sale_device_id •id
Anchor to processed_at •time
Anchor to test •boolean

Anchor to themetheme

•OnlineStoreTheme

Returns an OnlineStoreTheme by its ID. Use this query to retrieve theme metadata and access the theme's files, which include templates, assets, translations, and configuration files.

Anchor to idid •ID! required: The ID of the theme.

Anchor to themesthemes

•OnlineStoreThemeConnection

Returns a paginated list of OnlineStoreTheme objects for the online store. Themes control the appearance and layout of the storefront.

You can filter themes by role to find specific theme types, such as MAIN for the published theme and UNPUBLISHED for draft themes.

Arguments

Anchor to rolesroles

•[ThemeRole!]

The theme roles to filter by.

Anchor to namesnames

•[String!]

The theme names to filter by. Use '*' to match zero or more characters.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

•TranslatableResourceConnection!

Default:false

Reverse the order of the underlying list.

Anchor to translatableResourcetranslatableResource

•TranslatableResource

Retrieves a resource that has translatable fields. Returns the resource's Translation objects for different locales and markets, along with the original TranslatableContent and digest values needed to register new translations. Provides access to existing translations, translatable content with digest hashes for translation registration, and nested translatable resources like ProductVariant objects or Metafield objects.

Learn more about managing translated content.

Anchor to resourceIdresourceId •ID! required: Find a translatable resource by ID.

Anchor to translatableResourcestranslatableResources

non-null

Returns a paginated list of TranslatableResource objects for a specific resource type. Each resource provides translatable content and digest values needed for the translationsRegister mutation.

Learn more about managing translated content.

Arguments

Anchor to resourceTyperesourceType

•TranslatableResourceType!

required

Return only resources of a type.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

•TranslatableResourceConnection!

Default:false

Reverse the order of the underlying list.

Anchor to translatableResourcesByIdstranslatableResourcesByIds

non-null

Returns a paginated list of TranslatableResource objects for the specified resource IDs. Each resource provides translatable content and digest values needed for the translationsRegister mutation.

Learn more about managing translated content.

Anchor to resourceIdsresourceIds •[ID!]! required: Return only resources for given IDs.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to urlRedirecturlRedirect

•UrlRedirect

Returns a UrlRedirect resource by ID.

Anchor to idid •ID! required: The ID of the UrlRedirect to return.

Anchor to urlRedirectImporturlRedirectImport

•UrlRedirectImport

Returns a UrlRedirectImport resource by ID.

Anchor to idid •ID! required: The ID of the UrlRedirectImport to return.

Anchor to urlRedirectsurlRedirects

•UrlRedirectConnection!

non-null

A list of redirects for a shop.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•UrlRedirectSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to path •string
Anchor to target •string

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to urlRedirectSavedSearchesurlRedirectSavedSearches

non-null

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

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to urlRedirectsCounturlRedirectsCount

•Count

Count of redirects. Limited to a maximum of 10000 by default.

Arguments

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to path •string
Anchor to target •string

Anchor to savedSearchIdsavedSearchId

•ID

The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to validationvalidation

•Validation

Validation available on the shop.

Anchor to idid •ID! required: The ID of the validation.

Anchor to validationsvalidations

•ValidationConnection!

non-null

Validations available on the shop.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•WebhookSubscriptionConnection!

•ValidationSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

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 idid •ID! required: The ID of the WebhookSubscription to return.

Anchor to webhookSubscriptionswebhookSubscriptions

non-null

Retrieves a paginated list of webhook subscriptions created using the API for the current app and shop.

Note

Returns only shop-scoped subscriptions, not app-scoped subscriptions configured in TOML files.

Subscription details include event topics, endpoint URIs, filtering rules, field inclusion settings, and metafield namespace permissions. Results support cursor-based pagination that you can filter by topic, format, or custom search criteria.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•WebhookSubscriptionSortKeys

Default:CREATED_AT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•[WebhookSubscriptionTopic!]

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to updated_at •time

Anchor to callbackUrlcallbackUrl

•URL

Deprecated

Anchor to uriuri

•String

URI to filter by. Supports an HTTPS URL, a Google Pub/Sub URI (pubsub://{project-id}:{topic-id}) or an Amazon EventBridge event source ARN.

Anchor to formatformat

•WebhookSubscriptionFormat

Response format to filter by.

Anchor to topicstopics

List of webhook subscription topics to filter by.

Anchor to webhookSubscriptionsCountwebhookSubscriptionsCount

•Count

The count of webhook subscriptions.

Arguments

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to created_at •time
Anchor to endpoint •string
Anchor to id •id: Filter by id range.
Anchor to topic •string
Anchor to updated_at •time

•MarketWebPresenceConnection

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to webPixelwebPixel

•WebPixel

Returns a web pixel by ID.

Anchor to idid •ID: The ID of the WebPixel object to return.

Anchor to webPresenceswebPresences

The web presences for the shop.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Deprecated fields

Anchor to automaticDiscountautomaticDiscount

•DiscountAutomatic

Deprecated

Anchor to automaticDiscountNodesautomaticDiscountNodes

•DiscountAutomaticNodeConnection!

non-nullDeprecated

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•AutomaticDiscountSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•DiscountAutomaticConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to id •id: Filter by id range.
Anchor to status •string: Filter by the discount status.
Anchor to type •string: Filter by the discount type.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to automaticDiscountsautomaticDiscounts

non-nullDeprecated

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•AutomaticDiscountSortKeys

Default:CREATED_AT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•DiscountCodeNodeConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to id •id: Filter by id range.
Anchor to status •string: Filter by the discount status.
Anchor to type •string: Filter by the discount type.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to codeDiscountNodescodeDiscountNodes

non-nullDeprecated

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CodeDiscountSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to combines_with •string: Filter by the discount classes that you can use in combination with Shopify discount types.
Anchor to created_at •time: Filter by the date and time when the discount was created.
Anchor to discount_type •string: Filter by the discount type.
Anchor to ends_at •time: Filter by the date and time when the discount expires and is no longer available for customer use.
Anchor to id •id: Filter by id range.
Anchor to starts_at •time: Filter by the date and time, in the shop's timezone, when the discount becomes active and is available for customer use.
Anchor to status •string: Filter by the status of the discount.
Anchor to times_used •integer: Filter by the number of times the discount has been used. For example, if a "Buy 3, Get 1 Free" t-shirt discount is automatically applied in 200 transactions, then the discount has been used 200 times.

This value is updated asynchronously. As a result, it might be different than the actual usage count.
Anchor to title •string: Filter by the discount name that displays to customers.
Anchor to type •string: Filter by the discount type.
Anchor to updated_at •time: Filter by the date and time when the discount was last updated.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to collectionByHandlecollectionByHandle

•Collection

Deprecated

Anchor to handlehandle •String! required: The handle of the collection.

Anchor to currentBulkOperationcurrentBulkOperation

•BulkOperation

Deprecated

Arguments

•[DeletionEventSubjectType!]

•BulkOperationType

Default:QUERY

The current bulk operation's type.

Anchor to deletionEventsdeletionEvents

•DeletionEventConnection!

non-nullDeprecated

Arguments

Anchor to subjectTypessubjectTypes

List of subject types to filter by.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•DeletionEventSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.