---
title: Deeplinks
description: >
  Learn how to implement and test deeplinks in your Shop Mini. This guide covers
  deeplink structure, testing during development, and best practices for
  handling different entry points into your Mini.
api_name: shop-minis
source_url:
  html: 'https://shopify.dev/docs/api/shop-minis/deeplinks'
  md: 'https://shopify.dev/docs/api/shop-minis/deeplinks.md'
---

# Deeplinks

Learn how to implement and test deeplinks in your Shop Mini. This guide covers deeplink structure, testing during development, and best practices for handling different entry points into your Mini.

***

## Overview

Deeplinks enable users to navigate directly to specific content within your Shop Mini. They provide seamless entry points from external sources like push notifications, marketing campaigns, or other apps directly into specific screens or features of your Mini.

Key benefits:

* **Direct navigation**: Users can jump straight to relevant content
* **Enhanced user experience**: Reduces friction by eliminating navigation steps
* **Cross-app integration**: Allow other apps and services to link directly to your Mini's content

***

## Testing Deeplinks During Development

During development, you can test how your Mini handles different deeplink paths to ensure proper navigation and parameter handling. The Shop Minis dev server provides two convenient methods for testing deeplinks.

### Why Test Deeplinks?

Testing deeplinks during development helps you:

* Verify that navigation to specific screens works correctly
* Test entry points with query parameters
* Debug routing logic and path handling
* Ensure a smooth user experience when users arrive from external sources
* Validate that your Mini properly handles various path formats

### Method 1: Terminal Shortcut (Press `d`)

The quickest way to test deeplinks is directly from the development terminal:

1. Start your development server with `npm start`
2. Press `d` in the terminal
3. Enter your desired path when prompted (e.g., `/recipe/123` or `/search?q=pasta`)
4. Select your target platform (iOS Simulator or Android Device/Emulator)
5. Your Mini will automatically launch with the specified deeplink path

![Terminal showing deeplink option and path prompt](https://shopify.dev/assets/assets/images/api/shop-minis/deeplink-cli-DxPYbADb.png)

### Method 2: QR Code with Initial Path

For testing on physical iOS devices:

1. Start your development server with `npm start`
2. Press `q` to open the QR code page in your browser
3. Enter your desired path in the **"Initial Path"** field
4. Scan the QR code with your iOS device
5. Your Mini will open directly to the specified path

![QR code page showing the Initial Path input field](https://shopify.dev/assets/assets/images/api/shop-minis/deeplink-qr-BU_YEELP.png)

***

## Path Format

Paths should follow standard URL path conventions. The development server automatically handles path normalization, so both formats with and without leading slashes work correctly.

### Basic Path Formats

* **Simple navigation**: `/about`, `/settings`, `/products`
* **Resource with ID**: `/product/123`, `/user/profile/456`
* **Query parameters**: `/search?q=shoes&category=mens`
* **Complex paths**: `/category/electronics/phones?brand=apple&sort=price`
* **Root path**: `/` (navigates to your Mini's home screen)

### Path Normalization

Leading slashes are handled automatically by the development server:

* `/products` → normalized to `products`
* `products` → remains `products`
* `/` → special case, preserved as root

This ensures consistent behavior regardless of how developers enter paths during testing.

***