Scanner
The Scanner action set allows you to use the mobile device's camera to scan barcodes.
Requirements
Anchor link to section titled "Requirements"These actions require the following app versions:
- Shopify iOS v8.25.0 or above
- Shopify Android v8.24.0 or above
- Point of Sale iOS v5.32.0 or above
- Point of Sale Android v3.25.0 or above
Create an app and import the Scanner module from @shopify/app-bridge/actions. Note that we'll be referring to this sample application throughout the examples below.
Scanner Capture action
Anchor link to section titled "Scanner Capture action"| Group | Scanner |
|---|---|
| Action | CAPTURE |
| Action Type | APP::SCANNER::CAPTURE |
| Description | Dispatches when a scan is successful. |
To open a Scanner component, you must first use Feature Detection to check whether it's available. If it is, then you can open it. To learn more about Feature Detection, see Features.
| Key | Type | Description |
|---|---|---|
scanData |
String? | The resulting string from scanning a barcode. |
Request access and Open Camera action
Anchor link to section titled "Request access and Open Camera action"| Group | Scanner |
|---|---|
| Action | OPEN::CAMERA |
| Action Type | APP::SCANNER::OPEN::CAMERA |
| Description | Opens a camera component for scanning barcodes. |