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.

Anchor to Base URLBase URL

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

You can also target a specific store directly:

Anchor to ParametersParameters

• 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.

Anchor to Smart GridSmart Grid

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

Open the Smart Grid editor:

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

Anchor to ReceiptsReceipts

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

Open a receipt template:

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

Open the receipt printing options:

Anchor to Customer displayCustomer display

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

Anchor to SettingsSettings

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

Anchor to Permissions and fallbacksPermissions 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.

Anchor to Next stepsNext steps

POS UI extension targets

Learn about the locations in the POS interface where your extension can appear.

Extending Shopify POS with UI extensions

Learn about the ways you can integrate your app into Shopify POS.