Developer Docs
Search…
⌃K

Implementation Guide

Get an overview of integration with Seel Return Assurance.
If you are a Shopify merchant, you can simply install our Shopify app or visit our Open Platform to connect your store.
If you are developing for a non-Shopify platform or an e-commerce marketplace, please follow the instructions below to start your integration with Seel Return Assurance.
No two marketplaces are the same, so we can be very flexible to accommodate different types of integration. Please feel free to contact us at [email protected] for any customization requests.

Overview

The overall integration consists of two parts:
1) Embedding Seel Pixel, for storefront widget displaying and underwriting
2) Integrating with Seel API, for updating insured order's shipping information or canceling a policy.
Below is a high-level overview of the implementation:

Data flow

The main parts that require implementation are:
  1. 1.
    Frontend: Place Seel Pixel in webpage headers;
  2. 2.
    Frontend: Set up onRAChecked() and onRAUnchecked() callback functions to update order total;
  3. 3.
    Frontend: Call createPolicy() when a new purchase is made;
  4. 4.
    Backend: Call updateAsset() when order is shipped;
  5. 5.
    Backend: Call cancelPolicy() when order is canceled;
  6. 6.
    Place the Seel Return Portal link on the Return Policy page.
In addition to these core functions, Seel also provides a dashboard - Open Platform as well as RESTful API to manage policies, returns, billing, and other configurations.