10/17/2025, 12:00:54 AM
New allChannels query lists all active sales channels and supports pagination and reverse ordering. Description of appInstallation and appInstallations query now explicitly outlines usage for access scopes, subscriptions, billing, and installation state, including the availability of read_apps scope for custom and public apps. The automaticDiscount query continues to be deprecated but its description now clarifies that it returns a DiscountAutomatic union rather than an old generic resource. The customerSegmentMembersCount query now explains real‑time segment size calculations using provided criteria. Operators can now use more detailed filter syntax for customers, orders, and giftCards queries; giftCards’ default search now includes code matching; orders’ discount code filter now limits to the first code used. The mutation appRevokeAccessScopes has been rewritten to explain that it will remove specific permissions while keeping other app functionality and returns granular success or error information. WebhookSubscriptions’ description was expanded to detail the returned data, pagination, and how app‑scoped versus shop‑scoped subscriptions are distinguished.
List of all the active sales channels on this shop.
Look up an app installation by ID or return the app installation for the currently authenticated app.
Use the appInstallation query to:
Learn more about app installation.
A list of app installations. To use this query, your app needs the read_apps access scope, which can only be requested after you're granted approval from Shopify Support. This scope can be granted to custom and public apps.
Returns a paginated connection of AppInstallation objects across multiple stores.
Learn more about app installation.
Returns a DiscountAutomatic resource by ID.
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.
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.
Returns a list of gift cards.
The total number of gift cards issued for the shop. Limited to a maximum of 10000 by default.
Returns a OrderEditSession resource by ID.
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.
Returns the count of orders for the given shop. Limited to a maximum of 10000 by default.
Returns a ReturnableFulfillment resource by ID.
Returns a SubscriptionBillingAttempt resource by ID.
Returns a UrlRedirectImport resource by ID.
Retrieves a paginated list of shop-scoped webhook subscriptions configured for the current app. This query returns webhook subscriptions created via the API for this shop, not including app-scoped subscriptions configured via TOML files.
For example, an app dashboard might use this query to display all configured webhooks, showing which events trigger notifications and their delivery endpoints for troubleshooting integration issues.
Use the webhookSubscriptions query to:
The query returns comprehensive subscription data including event topics, endpoint configurations, filtering rules, API versions, and metafield namespace permissions. Each subscription includes creation and modification timestamps for tracking configuration changes.
Results support standard GraphQL pagination patterns with cursor-based navigation, allowing efficient retrieval of large webhook subscription lists. The response includes detailed endpoint information varying by type - HTTP callback URLs, EventBridge ARNs, or Pub/Sub project and topic specifications.
Advanced subscription features like event filtering using Shopify search syntax, field inclusion rules, and metafield namespace access are fully exposed, providing complete visibility into webhook configuration.
Learn more about webhook subscription queries.
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.
Revokes previously granted access scopes from an app installation, allowing merchants to reduce an app's permissions without completely uninstalling it. This provides granular control over what data and functionality apps can access.
For example, if a merchant no longer wants an app to access customer information but still wants to use its inventory features, they can revoke the customer-related scopes while keeping inventory permissions active.
Use the appRevokeAccessScopes mutation to:
The mutation returns details about which scopes were successfully revoked and any errors that prevented certain permissions from being removed.
Learn more about managing app permissions.
Uninstalls an app from a shop.
This mutation can only be used by apps to uninstall themselves. Apps with the apps access scope can uninstall other apps by providing the app ID in the input parameter.
Use the appUninstall mutation to programmatically remove apps from shops.
The mutation returns the uninstalled app and any errors that occurred during the uninstallation process.
Learn more about app lifecycle management.
Creates a new catalog. For a complete explanation of a Catalog's behaviour, and how you can use it with Publications and PriceLists, see here.
Marks a scheduled fulfillment order as open.
From API version 2026-01, this will also mark a fulfillment order as open when it is assigned to a merchant managed location and has had progress reported.
Creates a fulfillment service.
When creating a fulfillment service, a new location will be automatically created on the shop
and will be associated with this fulfillment service.
This location will be named after the fulfillment service and inherit the shop's address.
If you are using API version 2023-10 or later, and you need to specify custom attributes for the fulfillment service location
(for example, to change its address to a country different from the shop's country),
use the
LocationEdit
mutation after creating the fulfillment service.
Updates a fulfillment service.
If you need to update the location managed by the fulfillment service (for example, to change the address of a fulfillment service), use the LocationEdit mutation.
Creates a new product bundle or componentized product.
Updates a product bundle or componentized product.
Set up webhook subscriptions so your app gets notified instantly when things happen in a merchant's store. Instead of constantly checking for changes, webhooks push updates to your app the moment they occur, making integrations faster and more efficient.
For example, an inventory management app might create subscriptions for orders/paid and inventory_levels/update events to automatically adjust stock levels and trigger fulfillment processes when customers complete purchases.
Use webhookSubscriptionCreate to:
The mutation supports multiple endpoint types and advanced filtering options, allowing you to create precisely targeted webhook subscriptions that match your app's integration needs. The API version is inherited from the app configuration and cannot be specified per subscription. Filters use Shopify search syntax to determine which events trigger notifications.
Successful creation returns the webhook subscription fields that you request in your query. The mutation validates topic availability, filter syntax, and endpoint configuration.
Learn more about creating webhook subscriptions.
Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your shopify.app.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.
Removes an existing webhook subscription, stopping all future event notifications for that subscription. This mutation provides a clean way to deactivate webhooks when they're no longer needed.
For example, when an app feature is disabled or when you need to change webhook configurations, you can delete
the old webhook subscription to prevent unnecessary event delivery and potential errors. Alternatively, for
endpoint changes, you might consider updating the existing subscription instead of deleting and recreating it.
Use webhookSubscriptionDelete to:
The mutation returns the deleted subscription's ID for confirmation when successful. Validation errors are included in the response if you request them in your query, as with all GraphQL mutations.
Learn more about managing webhook subscriptions.
Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your shopify.app.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.
Updates an existing webhook subscription's configuration, allowing you to modify endpoints, topics, filters, and other subscription settings without recreating the entire subscription. This mutation provides flexible webhook management for evolving app requirements.
For example, when migrating from HTTP endpoints to EventBridge, you can update the subscription's endpoint configuration while preserving the same topic subscriptions and filters, ensuring continuity of event delivery during infrastructure changes.
Use webhookSubscriptionUpdate to:
The mutation supports comprehensive configuration changes including endpoint type switching (HTTP to Pub/Sub, for instance), topic modifications, and advanced filtering updates. The API version is inherited from the app configuration and cannot be changed per subscription.
Updates are applied atomically, ensuring that webhook delivery continues uninterrupted during configuration changes. The response includes the updated subscription fields that you request in your query, and validation errors if requested.
Learn more about updating webhook configurations.
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.
Third-party app subscription overrides for a shop.
productsCountapiClientIdbrandingConfigurationfeatureConfigurationshopIdfeatureThe feature configuration for checkout and accounts app.
ordersordersPREVENTEDLOCATION_NOT_FOUNDLOCATION_NOT_FOUNDLOCATION_NOT_FOUNDLOCATION_NOT_FOUNDCANNOT_DELETE_PROVINCE_MARKETINVALID_CUSTOMIZATION_FOR_PROVINCE_CONDITIONRESOURCE_TYPE_LIMIT_EXCEEDED_BY_APPSTANDARD_METAFIELD_DEFINITION_DEPENDENT_ON_APPINVALIDSTANDARD_METAOBJECT_DEFINITION_DEPENDENT_ON_APPsharedCheckoutproductNetworkWhether the customer also purchased items from other stores in the network.
customersproductBundleOperationproductBundleOperationimagedraftOrdersappTrialEligibleWhether the shop is eligible for app trials offered by third-party apps.
customersordersthirdPartyAppSubscriptionOverrideAll third party app subscription overrides for the shop.
RESPONSE_SUMMARY_FILEADS_PUBLISHER_CREDITADS_PUBLISHER_CREDIT_REVERSALINSTALLMENTS_BALANCE_RECOVERY_DEBITINSTALLMENTS_BALANCE_RECOVERY_DEBIT_REVERSALMANAGED_MARKETS_DUTIES_AND_TAXES_ADJUSTMENT_PLATFORM_DEBITMANAGED_MARKETS_DUTIES_AND_TAXES_ADJUSTMENT_PLATFORM_CREDITMANAGED_MARKETS_DUTIES_AND_TAXES_ADJUSTMENT_PLATFORM_DEBIT_REVERSALMANAGED_MARKETS_DUTIES_AND_TAXES_ADJUSTMENT_PLATFORM_CREDIT_REVERSALMANAGED_MARKETS_MERCHANT_OF_RECORD_ACCOUNT_NETTING_CREDITMANAGED_MARKETS_MERCHANT_OF_RECORD_ACCOUNT_NETTING_CREDIT_REVERSALMANAGED_MARKETS_MERCHANT_OF_RECORD_ACCOUNT_NETTING_DEBITMANAGED_MARKETS_MERCHANT_OF_RECORD_ACCOUNT_NETTING_DEBIT_REVERSALCURRENCY_NOT_ENABLED