Documentation

Quickstart

Connect a store and process your first return in under ten minutes.

This guide takes you from zero to a live returns portal. You'll connect a store, configure a basic policy, and walk a test return through the loop.

1. Connect your store

Install the Shopify app via OAuth, or connect Ticimax with a WS auth key. Each platform sits behind the same platform-blind adapter core.

bash

# Shopify — install via OAuth
open https://api.resreturn.com/v1/merchant/integrations/shopify/install?shop=maison-re.myshopify.com

# Ticimax — connect with a WS auth key
curl -X POST https://api.resreturn.com/v1/merchant/integrations/ticimax/connect \
  -H 'Authorization: Bearer ys_live_…' \
  -d '{ "domain": "maisonre.com", "wsKey": "…" }'

2. Configure a policy

Set a return window and your default outcome ladder. Everything is overridable per category later.

The EU withdrawal button is enabled by default and cannot be gated behind final-sale rules — by law.

3. Test the loop

Submit a return through the portal, advance it through approve → ship → receive, and watch the signal land in analytics.

Introduction

Returns portal