Build on top of MerchantDesk
Today, the widget embed below is the real, supported integration surface. A full public REST API is planned for its own subdomain — documented here in the meantime so nothing's fabricated ahead of it actually existing.
Overview
MerchantDesk isn't an API-first product today — it's a Shopify app with a chat widget that embeds on your storefront. The one real, stable integration point a developer can rely on is that embed script.
Most merchants never touch this directly — installing through the Shopify app adds it automatically. It's documented here for merchants and theme developers who manage their own theme code and want to place or move it manually.
Widget Embed
Add this tag once, anywhere in your theme's <body> — commonly in theme.liquid, right before the closing body tag.
<script src="https://yourdomain.com/widget.js" data-key="YOUR_WIDGET_KEY" async></script>data-keyis your store's unique widget key — find it under Widget Builder → Install in your portal. It's not a secret credential; it only identifies which store's widget configuration to load.
Configuration
The embed tag itself takes no other parameters — position, primary color, greeting message, and bot name are all configured server-side from Widget Builder in your portal and take effect immediately, without touching the script tag or your theme again.
Roadmap
A full public REST API (conversations, catalog, order-lookup data) is planned for its own subdomain. Until then, this page stays scoped to what actually exists today rather than documenting endpoints that don't.
