Quick-login links allow merchants to create personalised return portal URLs that pre-fill customer details and optionally submit the form automatically. These links improve the customer experience by making it easier to access their return request.
This article is for users of Returns V2. For the Returns V1 version, click here.
URL Parameters
Quick-login links are constructed using three parameters:
&e= — Customer’s email address
Must be URL-encoded (e.g. @ becomes %40)
&o= — Order number
Must be URL-encoded (e.g. # becomes %23)
&a= — Auto-login behaviour
Only valid value: true
If set to true and both &e= and &o= are present, the form is auto-submitted and the customer is redirected to the Returns page
If omitted or not set to true, the form fields will be pre-filled but not submitted
Constructing the URL
Start with the base URL of your store’s return portal.
Add parameters in the following format:
?s=1&lang=&e={customer_email}&o={order_number}&a=trueMake sure all dynamic values are properly URL-encoded.
Examples
Here are some example links.
Auto-submission enabled
Base return portal URL:
Email: [email protected]
Order number: #1234
Constructed URL:
<https://returnsportal.shop/examplestore?s=1&lang=&e=customer%40example.com&o=%231234&a=true>
This link pre-fills the email and order number and attempts to submit the form automatically.
Auto-submission disabled
Constructed URL:
<https://returnsportal.shop/examplestore?s=1&lang=&e=customer%40example.com&o=%231234>
This version pre-fills the fields but does not attempt submission.