Embed the Returns Widget on your website

The nShift Returns widget lets your customers initiate their returns directly on your website without leaving your store.
 

Prerequisites

• Access to the nShift Returns configuration interface
• Ability to edit your website's HTML (or access to a developer who can)
• A market identifier (see Step 1)

Step 1.  Find your identifier 

1. Log in to the nShift Returns configuration interface
2. Go to Widget Settings > Market Setup
3. The following identifiers are available. Use one of the supported combinations:

Which should I use? marketId is recommended when possible - if a customer is redirected to the login page, it ensures the correct branding and language are shown immediately. customerName alone works when you have a single market. Use customerName + marketName when you have multiple markets under the same company.

Note: If you use Company Name alone, nShift Returns will automatically redirect the customer to the correct market based on their input.

Step 2. Configure embed permissions

Before the widget will load on your website, you need to tell nShift Returns which URL it is allowed to be displayed on.

1. In the configuration UI, go to Widget Settings > Market Setup > Embed permissions
2. Enter the full URL of the page where the widget will be shown - for example:
   https://www.yourstore.com/returns
3. Save your changes

This acts as an allowlist - the widget will only render when loaded from this exact URL.

Step 3. Add the widget to your website

Paste the following snippet into the page where the widget should appear, replacing the src value with the appropriate URL for your setup (see combinations below).

<!-- nShift Returns Widget -->
<iframe
  src="INSERT_URL_HERE"
  frameborder="0"
  marginheight="0"
  marginwidth="0"
  width="100%"
  height="700px"
  style="border: none;"
  title="Returns portal">
</iframe>

Supported URL combinations for the src:

Language — if no lang is provided, the widget will use the default language configured on the market. Supported language codes:

Base URLs by environment:

Pre-populating customer data

If your website has order information available - for example, when a customer arrives from an order confirmation page - you can pass their details directly in the widget URL. When valid credentials are present, the widget skips the login screen and takes the customer straight to orders page. Without them, the customer lands on the login page and enters their details manually.

These values are typically injected server-side by your platform when the page loads, keeping the embed snippet static while values are added dynamically per session.

Supported credential combinations

The widget accepts the following combinations. If multiple are present in the URL, the first match in this priority order is used:

https://www.nshiftreturns.com/ui/widget/redirect?marketId=YOUR_MARKET_ID&lang=en-us&email=customer@example.com&order=1234

https://www.nshiftreturns.com/ui/widget/redirect?marketId=YOUR_MARKET_ID&lang=en-us&customerId=0b6d015d-8f6d-412b-b976-6a1caebef839&order=1234

https://www.nshiftreturns.com/ui/widget/redirect?marketId=YOUR_MARKET_ID&lang=en-us&emailBase=Y3VzdG9tZXJAZXhhbXBsZS5jb20=&orderBase=MTIzNA==

https://www.nshiftreturns.com/ui/widget/redirect?marketId=YOUR_MARKET_ID&lang=en-us&customerId=0b6d015d-8f6d-412b-b976-6a1caebef839&orderBase=MTIzNA==