APIs

The useAppBridge hook returns the shopify global variable to use App Bridge APIs such as toast and resourcePicker.

The App API provides information about the app and the status of its extensions.

The config API stores the initial configuration information for your app and lets you synchronously retrieve it.

The Environment API provides utilities for information regarding the environment an App Home is running on.

The ID token API asynchronously retrieves an OpenID Connect ID Token from Shopify that can be used to ensure that requests came from a Shopify authenticated user.

The Intents API provides a way to invoke existing admin workflows for creating, editing, and managing Shopify resources.

The Loading API indicates to users that a page is loading or an upload is processing.

The Modal API allows you to display an overlay that prevents interaction with the rest of the app until dismissed.

The Navigation API allows you navigate within and outside of your app using the HTML anchor element.

The Picker API provides a search-based interface to help users find and select one or more resources that you provide, such as product reviews, email templates, or subscription options, and then returns the selected resource ids to your app.

The POS API provides the ability to retrieve POS user, device, and location data, while also interacting with the cart and closing the app.

The Print API allows you to print the content from your App Home on Shopify Mobile and Shopify POS devices.

The fetch API allows you to send a fetch request that is authenticated with an OpenID Connect ID Token from Shopify in the Authorization header.

The Resource Picker API provides a search-based interface to help users find and select one or more products, collections, or product variants, and then returns the selected resources to your app.

The Reviews API allows you to request an app review modal overlaid on your embedded app in the Shopify admin.

The Save Bar API is used to indicate that a form on the current page has unsaved information.

The Scanner API allows you to use the mobile device's camera to scan barcodes.

The Scopes API provides the ability to dynamically manage your access scopes within an embedded context.

The Share API allows you to invoke the "share sheet" to share content from your App Home on an iOS or Android device.

The Support API allows you to optionally register a custom handler when support requests are made directly through App Bridge.

The Toast API displays a non-disruptive message that appears at the bottom of the interface to provide quick and short feedback on the outcome of an action.

The User API lets you asynchronously retrieve information about the currently logged-in user.

The Web Vitals API allows you to access performance metrics for your app directly through App Bridge.