OVERVIEW

Loop offers API + Webhook integration solutions to allow our merchants to integrate critical aspects of their business, making it easier to manage, automate, and reconcile returns and exchanges.

This article will cover some of the most common use cases for merchants leveraging our APIs and webhooks.

Loop's API and webhooks are documented in more detail within our API reference pages.

The primary data flow for every integration involves sending or pulling returns information from Loop into third-party systems/software. Loop offers both Webhooks + our Returns API for receiving returns data.

Each time a customer initiates a return, a Loop webhook will deliver details of the return to a pre-defined endpoint. This data can be leveraged to create a record (RA, RMA, etc) in a third-party system. Subscribers can choose to receive webhooks upon the creation of a return, when the return status has been changed, or both.

In some cases, it’s best to pull returns from Loop on a recurring basis. You can do this by using two of our API's endpoints that deliver varying fidelities of returns data during a specified time period (date parameters):

• Advanced Shipping Notice

• Detailed Returns List

Example API responses can be found in the documentation above. 

You may find more information about Loop's API and how to use it in the Returns API section of Loop's API documentation.

Often, returns are automatically processed using carrier events such as “in_transit” or “delivered”. When this is not the case, and returns are being processed manually after returning to the warehouse, the Returns API can be leveraged to automate these actions.

There are four actions that can be taken via the API:

1. Process return

2. Flag return

3. Cancel return 

4. Close return

When a return has met merchant criteria and is approved, hitting the Process Return endpoint will process the return and execute the customer’s requested outcome in Shopify. 

Returns that require additional action can be flagged via the Flag Return endpoint. These returns will be sent to the “Needs Review” section of the Loop admin and can be actioned on a case-by-case basis by the merchant. 

Although typically actioned manually by the merchant to handle edge cases, the Cancel Return endpoint can be leveraged to cancel a return within Loop. 

Note: The customer will have the ability to resubmit a return or exchange that has been canceled until the Return Window closes.

You may also close a return via the Close Return endpoint. Closing a return does not allow a customer to resubmit an item in a later return, and it does not issue any refunds or exchanges that processing a return would issue.

Can I send custom parameters through the flag endpoint? Currently, no. However, this functionality will be included in future API enhancements. Please contact integrations@loopreturns.com to request webhook setup, API access, and/or additional documentation. 

I'm getting an "unauthorized" error when making API calls, what is wrong with the API key? Loop's API keys use "scopes" to determine what actions a key is allowed to be used for. If a key does not have the appropriate scope assigned to it then even if the key is valid you will get a 401 unauthorized response. For example: if you are trying to use the Details List API and your API key does not have the "Returns" scope you will get an "unauthorized" response. You can either make a new key with the required scope for your action or you can add the scope to your key in the Developer page of the admin. Keys can have multiple scopes; you may find more details about Loop's API scopes and when to use them in our API Key Scopes pages.

Can I edit a return using the API? At this time, returns cannot be edited after they are created.

Please reach out to support@loopreturns.com with any additional questions.