Integrate in your shop#
Resolve pages embed into your shop website through the Karla Browser SDK — a single script tag plus a container div.
Embed the resolve widget#
Add a container div and the bundle script to the page where you want the
resolve flow to render, and set data-starter-page="resolve" so the SDK
loads the resolve entry point:
<div id="karla-container"></div>
<script
id="karla-bundle"
src="https://browser.gokarla.io/latest/bundle.min.js"
data-shop-slug="my-shop-slug"
data-starter-page="resolve"
></script>
Replace my-shop-slug with your own shop slug (find it in the
portal under your shop profile).
For all supported script attributes, order lookup methods, debug options, and advanced configuration, see the Browser SDK reference.
Test your embed#
Once the page is published (e.g. https://your-shop-domain/resolve), add
order identifiers as URL parameters to preview a real resolution flow:
- ZIP code lookup:
https://your-shop-domain/resolve?orderNumber=00001&zipCode=10119 - Token-based lookup:
https://your-shop-domain/resolve?orderNumber=00001&token=abc123
Tokens unlock extra actions on the order
When you link to the resolve page with a token instead of a ZIP code, Karla treats the visitor as authenticated for that specific order. We reserve advanced, order-scoped operations (things like cancellation flows and similar sensitive actions) for token-authenticated sessions, and the set of capabilities behind the token keeps growing over time.
Token lookup is enabled by default on every shop (Shopify and others), and every notification Karla sends — including the resolve page URL in shipping emails — already carries the token for that order. You can also retrieve a token-protected URL for any order through our public API, so you can embed secure deep links in your own emails, flows, or support tools.
Skip issue selection#
If you want to route customers directly into a specific resolution flow
(e.g. a "Report damaged item" link that goes straight to the defective
flow), add the flowType URL parameter:
?flowType=defective?flowType=notReceived?flowType=return
Using the API directly#
If you'd rather build your own resolve UI from scratch, see the Claims API.