Skip to main content

Admin intents

Admin intents let you launch Shopify's native resource editors directly from your app. Instead of building custom forms for creating or editing Shopify resources, you call a single API and Shopify opens the same editors merchants already know. When they're done, they return to your app.

This guide covers how admin intents work, what you can do with them, and where they're available.


Your app calls shopify.intents.invoke() with an action (create or edit) and a resource type. Shopify opens the native resource editor as a contextual overlay. The merchant completes their action using the full-featured editor, and control returns to your app with the result.

shopify.intents.invoke('create:shopify/Collection');

Because the editors are built and maintained by Shopify, your app automatically benefits from new fields, validation rules, and UX improvements without any code changes.

Admin intents are available in two contexts:


You can open the native editor for creating a new resource by specifying the create action and a resource type.

Create a new product

const result = await shopify.intents.invoke('create:shopify/Product');
The native product editor opened from an app using admin intents.

You can open the native editor for an existing resource by specifying the edit action, a resource type, and a resource GID.

Edit an existing discount

const result = await shopify.intents.invoke('edit:shopify/Discount', {
value: 'gid://shopify/Discount/123445',
});
The native discount editor opened from an app using admin intents.

Admin intents support the following Shopify resources:

ResourceDescriptionCreateEdit
ArticleBlog posts published on the Online StoreYesYes
CatalogProduct groupings for B2B or multi-market sellingYesYes
CollectionGroups of products organized manually or by automated rulesYesYes
CustomerCustomer profiles with contact info, order history, and metadataYesYes
DeliveryProfileShipping rates and rules for products across locations and zonesYesYes
DiscountPrice reductions on products, orders, or shippingYesYes
LocationPhysical or virtual places where merchants store inventoryYesYes
MarketGeographic regions with customized pricing, languages, and domainsYesYes
MenuNavigation structures for the Online StoreYesYes
MetafieldDefinitionSchemas that define custom data fields for resourcesYesYes
MetaobjectCustom structured data entries based on metaobject definitionsYesYes
MetaobjectDefinitionSchemas that define the structure for metaobjectsYesYes
PageStatic content pages on the Online StoreYesYes
ProductItems sold in the store with pricing, inventory, and variantsYesYes
ProductVariantSpecific combinations of product options like size and colorYesYes
SettingsStore configuration like order processing, notifications, payments, gift cards, and defaultsNoYes

  • Explore the full intents API reference for App Home or admin UI extensions for advanced usage like handling responses and passing data parameters.

Was this page helpful?