Troubleshooting
This guide introduces some common errors that you might encounter when building your POS UI extension, and provides some resolutions to help resolve unexpected errors.
An API or a component doesn't work despite following the documentation
Anchor link to section titled "An API or a component doesn't work despite following the documentation"You're attempting to use the ScannerAPI, but it doesn't work. You've done everything according to the documentation.
The POS UI extensions documentation represents the latest version of our components and APIs. If you're using an older version of the POS UI extensions library, then some features mentioned in the documentation might not be available to you.
Visit the changelog to make sure you're using the latest version of POS UI extensions. Additionally, if your app has multiple extensions, please ensure that all extensions have the same version of the POS UI extensions library installed. Failure to do so may cause unexpected behavior when loading extensions from the development server. This will be fixed in a future release of the CLI.
Extension QR code does not work on Android
Anchor link to section titled "Extension QR code does not work on Android"
Android devices can have a restriction on how deep links are handled. To resolve this issue, you can use one of the following options:
Connect the device to your computer. Use Android Studio to open your deep link by running the following command:
adb shell am start "com.shopify.pos://pos-ui-extensions?url=<EXTENSION_URL>". Replace<EXTENSION_URL>with the URL that you want to test.Download and use a deep link opener app from Play Store.
Could not resolve "..."
Anchor link to section titled "Could not resolve "...""
This error is most likely from missing a dependency in package.json in the app root. Try re-installing your dependecies and running the app again.
'...' cannot be used as a JSX component
Anchor link to section titled "'...' cannot be used as a JSX component"
This issue commonly happens when Yarn is used for dependency management. The package's version was updated but npm conflicts with Yarn. In the root of your application run npm install to get it up to date as well. Restart your IDE if necessary.