Formerly known as deep-link API, the Orders API gives you the option of saving your customers the trouble of searching for their order within your Loop return portal and instead linking them directly to their return. Using the customer’s order number and zip code, you are able to provide them a custom link that you can include anywhere throughout their return experience.
Common Use Cases
Using the Orders API, you are essentially eliminating unnecessary friction and providing a seamless experience for your customers.
The most common use cases for these Orders API return links are:
- Order confirmation emails
- Order delivered email
- Customer’s order history page
- Customer’s account overview page
Setting up the API Call
In order to properly make these calls you’ll need to have your Shopify store ID, the customer’s order number and the customer’s zip code.
Your store ID is a unique Loop ID number associated with your store. Reach out to firstname.lastname@example.org to find out what your store ID is.
There is also an endpoint that will return a link to a QR code image file that, when scanned, will take the user directly to their order in Loop so they can initiate a return, without requiring them to enter their order information. The deep link is also returned. Full endpoint documentation below:
Read the full documentation for this endpoint here:
Orders API is exclusive to merchants on a Loop Plus plan
Please reach out to email@example.com or your Onboarding/Account Manager if you have any other questions.