Admin links

This page was printed on May 25, 2019. For the current version, visit https://help.shopify.com/en/api/embedded-apps/app-extensions/shopify-admin/app-admin-access.

You can make your apps accessible to merchants throughout the Shopify admin by activating admin links. After you activate an admin link for your app, it will appear in the More actions menu on the pages in Shopify that you specify. From there, merchants can use your app to complete a task directly. For example:

The Order Printer app uses an admin link on order pages to let merchants print invoices:

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.

You can use the Preview section to see what your admin link will look like.

Track 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. For 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. For example: ?id=3295398979&shop=johns-apparel.myshopify.com.