Deep linking customers into the returns portal enables a frictionless returns experience. You only need two pieces of information to deep link: the Shopify order name and the shop’s Shopify domain. Here’s how to get started.

​

Become a Registered Third-Party App

Please submit the Loop Partner Registration form to become a registered third-party app in the Loop App Marketplace. Becoming a third-party app enables you to deep link customers into the returns portal. Once approved, Loop will provide a shared secret. Securely store this secret because you will use it to sign requests. Never allow this secret to be visible in the browser.

​

Redirect to Deep Link Endpoint

To deep link the customer into the returns portal you need to redirect the browser to our deep link API. When successful, the deep link API redirects to the returns portal.

​

Deep Link API

The deep link API can be reached at GET https://api.loopreturns.com/api/v1/app/deep-link

Required query parameters:

Use the shared secret to generate the HMAC digest, as described below. The HMAC should be added to the request’s query parameters. If the HMAC is verified and the other query parameters are valid then we will respond with a 307 Temporary Redirect that loads the returns portal for the order.

​

Generate the HMAC Digest for the Request

The HMAC used in the above API call should be generated using the following steps:

1. Construct the query string with the keys sorted in alphabetical order.

   Example: order=1000&partner=your-company&shop_domain=example.myshopify.com

2. Using the query string, generate a (lowercase) hex encoded HMAC using SHA-256.

​

HMAC Calculation Examples

const crypto = require('crypto');
const qs = require('qs');

const parameters = {
partner: "your-company", // Registered partner name
order: "1000", // Shopify order name
shop_domain: "example.myshopify.com" // Shop's Shopify domain
}

const alphabetizedQueryString = qs.stringify(parameters, { sort: ((a,b) => {
return a.localeCompare(b);
})});

const hmac = crypto.createHmac('sha256', 'your-partner-secret')
.update(alphabetizedQueryString.trim())
.digest('hex');