Getting started with app extensions
You're ready to start working with app extensions. You want to make your app's features accessible through the Shopify admin.
In this guide, you'll learn how to configure three different types of app extensions:
- Admin links: Make your app's features accessible to merchants throughout the Shopify admin.
- Bulk action links: Make your app's features accessible to merchants wherever action drop-down menus are available in the Shopify admin.
- Navigation links: Display your app's navigation items consistently across devices.
Requirements
Anchor link to section titled "Requirements"- You've created a Partner account and a development store.
- You understand how apps fit into Shopify and the different ways of distributing your app.
- You've created an app that uses Shopify CLI 3.0 or higher, or you've migrated your existing app so that it's compatible with Shopify CLI 3.0 or higher.
Add an admin link
Anchor link to section titled "Add an admin link"When you add an admin link for your app, the link displays in the More actions menu on the pages in Shopify that you specify. Merchants can then use your app to complete a task directly.
- Log in to your Partner Dashboard.
Click Apps.
Click the name of the app you want to create links for.
Click Extensions.
Click Create +.
Under Shopify admin, click the Admin links card.
Enter information in the following fields:
- Extension Name: The name of your extension. This name is used to manage your extension internally. It won't be shown to merchants.
- Link label: The text that will appear to the merchant. It should be task-oriented, and not just the name of your app.
- Link target URL: The URL where your app is hosted, or a specific URL for this task.
- Page to show link: The page where this link should appear to the merchant. Try to place it only where it makes logical sense for the user. In general, avoid adding admin links to every page of the Shopify admin.
Click Create.
The admin link is deployed to your production app and is immediately available to merchants that have installed your app on their store.
Optional: To add more admin links, click Create + and repeat steps 6-8.
The Order Printer app uses an admin link on order pages to let merchants print invoices:
The Digital Downloads app uses an admin link on product pages to let merchants add digital attachments:
Tracking incoming admin links
Anchor link to section titled "Tracking incoming admin links"You can track incoming admin links by using the parameters that identify the store or resource where your app is being used:
Each admin link includes a URL parameter that contains the store URL, which identifies the unique store or resource where your app was used:
Example: https://johns-apparel.myshopify.com/admin/orders/?shop=johns-apparel.myshopify.com
.
When your admin link is on a detail page (such as the order details page), the link also includes a URL parameter that contains the unique resource ID for the item on that page:
Example: ?id=3295398979&shop=johns-apparel.myshopify.com
Add a bulk action link
Anchor link to section titled "Add a bulk action link"You can make your apps accessible to merchants wherever action drop-down menus are available in the Shopify admin.
- From the Partner Dashboard, click Apps.
- Click the name of the app you want to create links for.
- Click Extensions.
- Click Create +.
- Under Shopify admin, click the Bulk action links card.
Enter information in the following fields:
- Extension Name: The name of your extension. This name is used to manage your extension internally. It won't be shown to merchants.
- Bulk action label: The text that will appear to the merchant. It should be task-oriented, and not just the name of your app.
- Link target URL: The URL where your app is hosted, or a specific URL for this task.
- Page to show link: The page where this link should appear to the merchant. You can select from the various places in the Shopify admin where the Actions menu appears.
Click Create.
The bulk action link is deployed to your production app and is immediately available to merchants that have installed your app on their store.
Optional: To add more bulk action links, click Create + and repeat steps 5-7.
When a merchant selects multiple orders on the Orders page of the Shopify admin, the Actions drop-down menu appears. You can use the Actions menu to prompt merchants to use your app, when they complete a bulk action:
Add navigation links
Anchor link to section titled "Add navigation links"You can add navigation links to display your app's navigation items consistently across devices.
- From the Partner Dashboard, click Apps.
- Click the name of the app you want to create links for.
- Click App setup.
- Under Embedded app, click Manage.
- Under Navigation, click Configure.
- From the Navigation bar page, click Add navigation link.
Enter information in the following fields, and click Add link:
- Name: Enter a title for the menu item. This title will be displayed to merchants.
- Link: Enter your subpage URL. The URL must be from the same source as your app.
The menu item is added to your list.
Optional: To add more navigation links, click Add navigation link, and repeat step 7.
Optional: To upload a navigation icon, click Upload icon.
Optional: To reorganize your navigation menu item’s order, drag each item to your desired order, or use the arrow buttons.
Optional: To remove a navigation link, click the trash can icon.
Click Save.
The navigation configuration is deployed to your production app and is immediately available to merchants that have installed your app on their store.
- Explore and build other app extensions to surface your app's functionality in Shopify.