---
title: Deep linking into Shopify POS editor
description: >-
  Learn how to deep link merchants into the Shopify Point of Sale (POS) editor
  in the Shopify admin.
source_url:
  html: 'https://shopify.dev/docs/apps/build/pos/deep-linking'
  md: 'https://shopify.dev/docs/apps/build/pos/deep-linking.md'
---

# Deep linking into Shopify POS editor

Admin editor deep links let your app send a merchant straight to a specific place in the Shopify Point of Sale (POS) editor in the Shopify admin, instead of asking them to navigate there manually. This is useful for onboarding flows, setup guides, and post-install steps that help merchants configure your app. For example, you can open the Smart Grid editor or a specific receipt template.

The POS channel exposes a configurable editor in the Shopify admin. You can link directly to it with URL query parameters.

The merchant must be signed in and have the staff permissions required for the target editor or section. If they don't, the POS channel redirects them to a safe fallback. See [Permissions and fallbacks](#permissions-and-fallbacks).

***

## Base URL

Use the store-agnostic universal link, which resolves the current store automatically:

## Universal link

```text
https://admin.shopify.com/apps/point-of-sale-channel/editor?<params>
```

You can also target a specific store directly:

## Store-specific link

```text
https://admin.shopify.com/store/<store-handle>/apps/point-of-sale-channel/editor?<params>
```

***

## Parameters

* **`currentEditor`** (required): the editor to open. One of `pointOfSale`, `receiptEditor`, or `customerDisplay`. If omitted or unknown, POS opens the first editor the merchant has access to.
* **`mode`** (`pointOfSale` only): which area to open. One of `sections` (default), `settings`, or `extensions`. `settings` opens the settings tab; `extensions` opens the Apps area.
* **`section`** (`pointOfSale` only): the section to open. One of `smartGrid`, `lockScreen`, or `checkout`. Permission-gated — removed from the URL if the merchant lacks access.
* **`content`** (`receiptEditor`): the receipt template. One of `sales-receipt` (default), `gift-receipt`, or `returns-receipt`.
* **`content`** (`customerDisplay`): the screen to open. One of `checkout` (default) or `idle`.
* **`resourceId`**: for `pointOfSale`, the Smart Grid layout ID; for `receiptEditor`, the location ID whose receipt configuration to open.
* **`settings`** (`receiptEditor`): set to `printingOptions` to open the receipt printing options.

***

## Smart Grid

The Smart Grid is the POS home screen. It lives under `currentEditor=pointOfSale`.

Open the Smart Grid editor:

## Open the Smart Grid editor

```text
.../editor?currentEditor=pointOfSale&mode=sections&section=smartGrid
```

Open a specific Smart Grid layout by passing the layout ID as `resourceId`:

## Open a specific layout

```text
.../editor?currentEditor=pointOfSale&mode=sections&section=smartGrid&resourceId=<layout_id>
```

***

## Receipts

Receipt templates live under `currentEditor=receiptEditor`. If you omit `content`, POS defaults to the sales receipt.

Open a receipt template:

## Open a receipt template

```text
.../editor?currentEditor=receiptEditor&content=sales-receipt
.../editor?currentEditor=receiptEditor&content=gift-receipt
.../editor?currentEditor=receiptEditor&content=returns-receipt
```

Open a receipt for a specific location by passing the location ID as `resourceId`:

## Open a receipt for a location

```text
.../editor?currentEditor=receiptEditor&content=sales-receipt&resourceId=<location_id>
```

Open the receipt printing options:

## Open printing options

```text
.../editor?currentEditor=receiptEditor&settings=printingOptions
```

***

## Customer display

The customer display editor lives under `currentEditor=customerDisplay`. If you omit `content`, POS defaults to the checkout screen.

## Open the customer display editor

```text
.../editor?currentEditor=customerDisplay&content=checkout
.../editor?currentEditor=customerDisplay&content=idle
```

***

## Settings

You can deep link to the POS editor settings tab as a whole:

## Open the settings tab

```text
.../editor?currentEditor=pointOfSale&mode=settings
```

**Note:**

There is currently no deep link to a specific setting or to toggle an individual setting — only to the settings tab as a whole.

***

## Permissions and fallbacks

Deep links respect the merchant's staff permissions and can't be used to bypass them. If the merchant lacks access to the requested editor or section, the editor either redirects them or strips that parameter from the URL. Build deep links defensively and assume the merchant might land on a fallback screen.

***

## Next steps

[POS UI extension targets\
\
](https://shopify.dev/docs/api/pos-ui-extensions/latest/targets)

[Learn about the locations in the POS interface where your extension can appear.](https://shopify.dev/docs/api/pos-ui-extensions/latest/targets)

[Extending Shopify POS with UI extensions\
\
](https://shopify.dev/docs/apps/build/pos)

[Learn about the ways you can integrate your app into Shopify POS.](https://shopify.dev/docs/apps/build/pos)

***