Action API

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

View Action API

Cart API

The Cart API enables UI Extensions to manage and interact with POS cart contents, such as discounts, line items, and customer details. It provides a comprehensive set of functions for adding and removing items, alongside a subscribable object that keeps the UI Extension updated with real-time changes to the cart.

View Cart API

Connectivity API

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

View Connectivity API

Device API

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

View Device API

Locale API

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

View Locale API

Navigation API

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

View Navigation API

Order API

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

View Order API

ProductSearch API

The ProductSearch API gives extensions access to the native product search and fetching functionality of Shopify POS. The interface provides numerous functions to search for products by query, or to fetch the details of one or more products or product variants.

View ProductSearch API

Scanner API

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

View Scanner API

Session API

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.

View Session API

Toast API

The Toast API allows the display of a Toast component.

View Toast API