Skip to main content

About admin intents

Admin intents create collection workflow

Admin intents enable you to seamlessly launch Shopify's native resource editors directly from your app without breaking merchant context. This API bridges the gap between your app's functionality and Shopify's polished admin experience, allowing merchants to create and edit core resources while staying within your app's workflow.

With a single line of code, you can provide merchants access to the same feature-complete editors they already know and love, eliminating the need to build custom admin interfaces.

Anchor to RequirementsRequirements

Prerequisites:

Anchor to How admin intents workHow admin intents work

Admin intents work through simple API calls that launch Shopify's native resource editors as contextual overlays. When a merchant completes their action, they return directly to your app with all changes automatically reflected.

How to call intents from your app

/* Create a new Shopify collection from your app */
shopify.intents.invoke('create:shopify/Collection');

/* Launch the native product editor for a specific product */
shopify.intents.invoke('edit:shopify/Product', {
value: 'gid://shopify/Product/123445'
});

Anchor to Supported resourcesSupported resources

Admin intents support all core Shopify resources:

  • Products - Launch the full product editor with variants, SEO, and media handling.
  • Collections - Create and modify product collections with advanced filtering.
  • Customers - Edit customer profiles and manage customer data.
  • Catalogs - Manage product catalogs and their organization.
  • Metaobjects - Handle custom data structures seamlessly.
  • Metafields - Manage additional resource data without custom forms.
  • Markets - Configure market-specific settings and localization.
  • Discounts - Create and manage promotional campaigns.

Anchor to Create a Shopify resourceCreate a Shopify resource

Create a Shopify resource (for example, Product, Customer, Market) from your app home or admin UI extension by calling the intents API.

Admin intents create product workflow

Create a Shopify resource from the Intents API

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

Anchor to Edit an existing Shopify resourceEdit an existing Shopify resource

Edit an existing Shopify resource (for example, Product, Customer, Market) from your app home or admin UI extension by calling the intents API with the edit parameter and a valid resource ID.

Admin intents edit discount workflow

Create a Shopify resource from the Intents API

shopify.intents.invoke('edit:shopify/Discount', {
value: 'gid://shopify/Discount/123445'
});

Anchor to BenefitsBenefits

Anchor to Faster developmentFaster development

Build on Shopify's proven admin interface instead of recreating it. Focus on your app's unique features while leveraging years of UX research built into Shopify's editors.

Anchor to Better merchant experienceBetter merchant experience

Keep merchants engaged by eliminating context switching. They can manage core resources without losing their place in your workflow.

Anchor to Consistent interfaceConsistent interface

Provide merchants with the familiar, polished experience they expect while maintaining your app's branding and flow.

Anchor to Developer tools and resourcesDeveloper tools and resources

Shopify App Bridge intents API reference

Consult the intents API reference for Shopify App Bridge.

Admin UI extensions intents API reference

Consult the intents API reference for admin UI extensions.

Was this page helpful?