You can use Admin links to make your app's features accessible to merchants with the purpose of functionality in mind. Their intended use is for merchants to be able to access and use specific functions or actions of an app.
Add links to your app through the Shopify Admin
You can make your apps accessible to merchants throughout their Shopify admin by adding links to the Apps dropdown using admin links in your Partners Dashboard. For example:
Admin links can be accessed from many different parts of the Shopify Admin. To find out where, visit your Partner Dashboard and follow the steps below.
To add Admin links into the merchant's Shopify admin:
Log in to your Partner Dashboard.
Click the name of the app you want to create links for.
In the Admin links section, click Add an admin link.
On the Add an admin link dialog, enter information in the following fields:
- Link label – The text that will appear to the merchant in Apps menu. 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. That is, we don't recommend adding Admin links to every page of the Shopify admin.
Click Add link.
To continue adding more Admin links, click Add an admin link and repeat step 6.
Admin links can be accessed from many different parts of the Shopify admin. To find out where, visit your Partner Dashboard and follow the steps above.
How it works
Shopify automatically adds a URL parameter to the Admin link that contains the store URL so your app knows which store or resource that the merchant came from. For example:
Also, when your Admin link is on a detail page (like the order detail page) Shopify also adds a URL parameter containing the resource ID. For example:
If we did not add these parameters your app wouldn't know which store or resource that the merchant came from.
How to use Admin links
Admin links are available for merchants so they can can control different parts of their store with the applications they have installed. Their responsibilities can be different based on the section they’re in but should always offer an actionable function associated to the application. For example:
The Order Printer application makes use of the Admin link on the Order Details page which gives the merchant the ability to print an invoice for that specific order
The Digital Downloads application allows merchants to go directly to a product within the Shopify Admin and add a digital attachment from the Admin links dropdown