Getting started with POS UI extensions

In this tutorial, you'll learn how to do the following tasks:

• Generate a POS UI extension using Shopify CLI.
• Run the local extension in your development store.
• Test your app in Shopify POS.

• Create a development store.
• Install or migrate to Shopify CLI version 3.0 or higher.
• Create an app.
• Embed your app in Shopify POS.

1. Navigate to your app directory.

2. Ensure @shopify/cli and @shopify/app packages are using the most up to date versions.

3. Generate your POS UI extension template.

4. Select POS UI under the Point-of-Sale menu.

5. Give your extension a working name.

6. Select the programming language that you want to work in.

After you create your extension, you can start a local development server so that you can run your extension in your development store.

When you start the server, Shopify CLI uses Cloudflare to create a secure tunnel. Cloudflare gives your app extension a unique URL.

1. Install your project's depdencies using the command from your package manager of choice.

2. Start your local server for your extension in the app directory.

3. Follow the prompts to associate your extension with your app and development store. Your development server should now be running.

   

4. Launch the UI extension developer console by opening the preview URL provided in the terminal. It should look something like https://attitudes-stays-recommend-beatles.trycloudflare.com/extensions/dev-console.

To learn more about the processes that execute when you run dev, refer to the Shopify CLI command reference.

1. In the UI extension developer console, you can install your app to your development store by opening the Preview link. It should open up a new URL and prompt you to install your app.

2. To preview your extension, select the View mobile button and this should generate a deep link or QR code.

3. Using a mobile device with the Shopify POS app installed, scan the QR code that was generated from your developer console. This will open Shopify POS on your device, and install the extension. If your extension's URL changes, then you need to re-add the smart grid extension tile.

You can refer to the list of the available POS UI Extension versions to see if there are any updates you can use.

• Follow along with an example discount extension.
• Explore the full reference of Shopify retail APIs and components that you can use for your POS UI extension.
• Learn how to deploy and publish a UI extension.