APIs
When you build an app for the App Home using the admin.app.home.render target, Shopify provides a set of APIs on the shopify global object. Use them to query the GraphQL Admin API, open Shopify admin workflows, and surface feedback to merchants.
App Home UI extensions receive the Standard API plus the Utility APIs listed below.
Anchor to Core APIsCore APIs
The Standard API is the baseline API available to every App Home UI extension. It handles authentication, GraphQL access, internationalization, and local storage.
| Name | Description |
|---|---|
| Standard API | Query the GraphQL Admin API, translate content, launch Shopify admin workflows, and persist data in browser storage. |
Anchor to Utility APIsUtility APIs
Utility APIs are helper APIs available to App Home UI extensions. They provide navigation, picker dialogs, loading and toast feedback, and Shopify admin workflows that the full-page surface needs.
| Name | Description |
|---|---|
| Intents API | Launch native Shopify admin workflows for creating and editing resources. |
| Loading API | Show or hide the Shopify admin header loading indicator during asynchronous work. |
| Navigation API | Navigate within your app and to other pages in the Shopify admin. |
| Picker API | Launch custom selection dialogs backed by your app's own data. |
| Resource Picker API | Launch pickers for Shopify resources like products, variants, and collections. |
| Toast API | Display brief notification messages at the bottom of the Shopify admin. |