If you are creating deep links for your own store and have access to your Loop
admin, use the generate order
link endpoint
instead.
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 GEThttps://api.loopreturns.com/api/v1/app/deep-link
Required query parameters:
Key | Description |
---|---|
order | Shopify order name |
partner | Your registered partner name |
shop_domain | The Shopify domain where the order was placed, such as example.myshopify.com |
hmac | HMAC value used to verify authenticity of request |
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:-
Construct the query string with the keys sorted in alphabetical order.
Example:
order=1000&partner=your-company&shop_domain=example.myshopify.com
- Using the query string, generate a (lowercase) hex encoded HMAC using SHA-256.