Support Menu

Contact Support

DeepLinks API

Create links that will automatically log the users into a specific order or return status page.

Create a URL for a customer to automatically login to an order or return status page.

Method/Url

POST https://api.fratereturns.com/api/v2/deep-links

Headers

X-Frate-Api-Token: <apiKey>

Payload

{ "order_name": "#1001", "zip_code_or_email": "00000", "target": "RETURN" # `RETURN` or `RETURN_STATUS` }

Response

{ "url": "http://<shopName>.fratereturns.com/deep-link?code=<code>" }