APIs

The Action API allows an action extension to modally present its corresponding modal target.

The Cart API enables UI Extensions to manage and interact with POS cart contents, such as discounts, line items, and customer details.

The Connectivity API enables POS UI extensions to retrieve device connectivity information, such as whether the device has an internet connection.

The Device API allows the UI Extension to retrieve device information including the device name and ID.

The Locale API allows the extension to retrieve the merchant's locale.

The Navigation API enables POS UI extension to navigate between screens.

The Order API provides an extension with data about the current order.

The ProductSearch API gives extensions access to the native product search and fetching functionality of Shopify POS.

The Scanner API enables an extension to access scanner data and available scanning sources supported by the device.

The Session API contains the information about the current user session, and allows to fetch a fresh session token for communication with your apps backend service.

The Toast API allows the display of a Toast component.