Shoppingate Logo
HomePartnerSell on E-commAbout UsContact UsDevelopers
Documentation
Get started
  • Getting started
  • Environments
Mini-app development
  • Authoring
  • app.json config
  • Lifecycle
  • Routing & query
  • Host functions
  • · orderPayment
  • Permissions
  • Deep links
Backend integration
  • Authentication
  • Endpoints
  • Webhooks
Building

Deep-link configuration

A deep link is a URI the super app resolves into a specific page inside your mini app. Push notifications, order receipts, support tickets, and share-sheet actions all use them to skip the mini-app home and land the user on the exact screen the message is about.

At minimum, configure the order_details deep link. Every order-status push notification, receipt email, CRM handoff, and the super app's own orders list points at this route so the customer lands on the exact order screen inside your mini app. Without it, every one of those taps falls back to your mini-app home.

Where to configure

Merchant portal → your mini app → Deep links. Each intent takes one field: a path_template starting with /, containing zero or more placeholders in {name} form. The platform swaps placeholders at runtime and builds the final URL against your mini-app's launch scheme.

Supported intents

Intent
What the link opens
Placeholder
order_details
The screen for one order in your mini app. Required if you accept orders — the platform routes every order-related notification here. The placeholder holds your own cart/order reference (the id your backend indexes by), not the platform's internal uuid.
{vendorOrderRef}
product_page
One product/item screen. Used by share-sheet links and any external CMS or campaign that surfaces individual items.
{productId}
search
Search-results screen pre-populated with a query. Used by voice-triggered handoffs and the super app's global search.
{query}
custom
Free-form passthrough for a raw path — for links generated by your own backend that don't fit the fixed intents.
{path}

Example config

{
  "order_details": { "path_template": "/orders/{vendorOrderRef}" },
  "product_page":  { "path_template": "/catalog/{productId}" },
  "search":        { "path_template": "/search?q={query}" },
  "custom":        { "path_template": "{path}" }
}

Templates must start with /. Every placeholder in a template must be in that intent's allowlist (shown above); unknown placeholders reject the whole config with INVALID_DEEP_LINK_CONFIG. Empty entries are fine — the platform simply won't build links for intents you don't opt into.

Testing

  • SG Studio simulator — Debug → Send deep link — instant round-trip against the running package.
  • Merchant portal preview — your mini app → Deep links → Preview renders the built URL and lets you open it in the test super app on a real device.
  • Real notification — trigger an order-status change via the S2S API and confirm the resulting push notification tap lands on the right screen.

Need help? We’re here.

Our team is ready to support you in every step of your experience.

Email Us
[email protected]
Sell With SGContact UsTerms of ServicePrivacy PolicyFAQTravel FAQ
Connect with us
X / TwitterLinkedInInstagramFacebookTiktok

Copyright © Shoppingate 2026

Mada
Visa
Mastercard
Apple Pay
Tamara