Returns portal integration guide

In this article we will show you how your customers can enter order in portal without introducing email or order number

1. Access to the portal using query string

  • The returns portal allows direct access to a request using two parameters in the query string:
    • Order: the number or name of the order for which the customer wishes to make a return
    • Email: the email of the customer who placed the order

✅ Example of URL

http://go.ifreturns.com/brandname?order=70001222&email=cliente@email.com

Important considerations:

  1. The link must be generated dynamically for each order, including the order number and the customer's email.
  2. The values of the query string must be encoded according to the RFC 3986 standard.

RFC 3986 is the standard that defines the syntax of Uniform Resource Identifiers (URIs). A URI is a compact sequence of characters that uniquely identifies a resource on the Internet.

URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]

Example

  • Normal values:
    order=70001222&email=cliente@email.com

  • Coded values:
    order=70001222&email=cliente%40email.com


2. Recovery of refund requests via API

To display the status of a return, you can use our REST endpoint:

🔗 GET /returns

It is possible to search for applications by:

  • Order number in Shopify
  • Customer's email

The response will include:

  • Order number
  • Number of items returned 
  • Status of the return
  • Date of the request
  • Return ID (GUID format)

 


Link to the tracking page

  • The return ID (GUID) can be used to generate a link to the request tracking page:

Example:

https://go.brandname.com/es/brandportal/7163e453-2a48-4b69-9104-29712593cb59


This link can be used for:

  • Show the status of the return in the customer's account

  • Include a button or direct link to the follow-up


In case of any doubts

Do not hesitate to contact us if you need more information or technical assistance.