Skip to main content

Apps in admin

Your app can extend the Shopify admin beyond App Home by adding functionality directly to resource pages like Products, Customers, and Orders. You can embed transactional workflows, display contextual information, launch native Shopify editors, and link to your app's pages.

There are two primary ways to extend the admin:

  • Admin UI extensions add custom actions, blocks, and print functionality to resource pages.
  • Admin intents launch Shopify's native resource editors directly from your app.
Note

Admin link extensions are also available but are recommended only when you need to navigate merchants to a page in your app. In most cases, admin UI extensions are a better choice.

Anchor to Admin UI extensionsAdmin UI extensions

Admin UI extensions let you embed your app's functionality on core admin pages. They automatically match the Shopify admin's look and feel, so merchants can interact with your app without navigating away from their current task.

Each UI extension is made up of three parts:

  • Targets define where your extension appears in the admin, such as a product details page or an order index table.
  • Target APIs provide data and methods specific to each target, like the current resource or the ability to close a modal.
  • Web components are the UI building blocks you use to render your extension's interface.

Anchor to Admin actionsAdmin actions

Admin actions display as modals that merchants launch from the More actions menu on resource pages, or from an index table's bulk action menu when one or more resources are selected. Use them for transactional workflows like creating, editing, or resolving records.

An example admin action UI extension.

Anchor to Admin blocksAdmin blocks

Admin blocks display as cards inline with existing resource information on admin pages. Merchants add and pin blocks to their pages. Use them to persistently display contextual information or let merchants edit data. You can also launch admin actions directly from blocks.

An example admin block UI extension on the product page showing created issues.

Anchor to Admin print actionsAdmin print actions

Admin print actions appear under the Print menu on orders and product pages. They include special APIs for previewing and printing documents like invoices and packing slips.

An example admin print action UI extension.

Anchor to Admin intentsAdmin intents

Admin intents let you launch Shopify's native resource editors directly from your app. With a single API call, you can open the same editors merchants already use to create and edit products, collections, and other resources. When merchants complete their action, they return directly to your app.

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

Admin intents work in both App Home and admin UI extensions.

Anchor to Build for adminBuild for admin

The following guides walk through common use cases for admin UI extensions. For the full reference, see admin UI extensions.

Anchor to Extension typesExtension types

Build an admin action

Create a modal workflow that merchants launch from a resource page's More actions menu.

Build an admin block

Display persistent contextual information or editable data inline on resource pages.

Build an admin print action

Add printable documents like invoices or packing slips to the Print menu on orders and product pages.

Anchor to DiscountsDiscounts

Add configuration UIs that let merchants set up custom discount types. See all discounts guides.

Build a UI extension for discounts

Add configuration to your discounts experience with metafields and a UI extension.

Build a discounts UI with React Router

Build a configuration experience for your discount type using a React Router app UI.

Anchor to BundlesBundles

Let merchants configure product bundles from within the admin. See all product bundles guides.

Add a merchant configuration UI

Build a product configuration extension that surfaces bundle settings on the product details page.

Anchor to Purchase optionsPurchase options

Let merchants create and manage selling plans for subscriptions and deferred purchases. See all purchase options guides.

Build a purchase options extension

Surface your app's purchase options in the Shopify admin with a purchase options extension.

Build a product subscription extension

Let merchants create and manage subscription selling plans on the product details page.

Anchor to Orders and fulfillmentOrders and fulfillment

Automate inventory, order routing, fulfillment, and returns workflows. See all orders and fulfillment guides.

Inventory management apps

Query and adjust inventory quantities on behalf of merchants.

Order management apps

Fulfill orders on behalf of merchants or let merchants fulfill orders through your app.

Order routing apps

Customize fulfillment and delivery strategies with Shopify Functions.

Returns apps

Capture the financial, logistical, and business intent of a return.

Anchor to Marketing and analyticsMarketing and analytics

Help merchants segment customers and run marketing automations from the admin. See all marketing and analytics guides.

Build a customer segment action extension

Let merchants trigger marketing actions on a customer segment from the admin.

Anchor to Next stepsNext steps

Was this page helpful?