Contents
Versioning: Returnly API v2020-08
Eligibility: Any merchant on any eCommerce platform that has an API key generated.
Ensure consistency across systems and build a custom returns stack using the Returnly API. By leveraging the Returnly API, merchants would be able to integrate with their business tools to aggregate and analyze data, or trigger events throughout the customer journey.
Use your returns data to take informed business decisions and improve your return experience.
The Returnly API allows your organization to access existing data (GET), and create new data (POST). To create an immutable record, there isn't any modification of existing data (PATCH), or the erasure of data (DELETE).
- The Returnly API documentation enables developers to seamlessly receive and pass up-to-date returns and refunds data into the platforms merchants use to run their business.
- The Returnly integration API documentation for merchants to set up endpoints on their own server so that Returnly could call on them to pull order, product/variant, and gift card data. There would be endpoints they would also set up in their servers for Returnly to send requests to - to create/complete exchange orders, refunds, and gift cards.
Important: this would be utilized by custom merchants who do not use the Shopify platform, but still want to utilize Returnly as a returns solution.
If you are a Returnly API customer and have questions or need help, please email Returnly’s merchant care team at support@returnly.com.
If you are a 3rd-party technology vendor and have questions about building an integration, please reach out to partners@returnly.com for support.
Setup Requirements
API access is available on Returnly's Premium Plan (Annual). If subscribed to a Monthly plan, please reach out to sales@returnly.com to learn more.
Additionally, we require that your organization be on the TLS 1.2+ standard, as well as have an SNI (Server Name Indicator).
If API access is enabled for your account, an active API token will be reflected within the Return Manager's (dashboard) Integration Tools section:
Learn how to obtain your API token.
Returnly API: Common Use Cases
- Update your Order Management System (OMS) with real-time returns data
- Get up to date returns status in real-time
- Leverage granular return data to optimize your current merchandise initiatives
- Track shipping and delivery of product returns
- Feed your CRM systems with real-time customer returns data
- Manage inventory predictably by monitoring returns and understanding which items have resell potential
- Manage inventory predictably by monitoring returns and understanding which items have resell potential
- Automate order refunds by connecting your warehouse scan system to the Returnly Refund API
- Refund to Gift Card to a specified payment method
- Refund RMAs which include different orders
- Refund RMAs with multiple shipping labels by sending 1 of the tracking numbers linked to the RMA.
Functionality
Basic functionality of the Returnly API is shown below. For more detailed information, please go here.
Returns (GET)
Receive and pass details on a collection of returns or a single return.
Merchants can retrieve:
- A collection of RMAs (Return Merchandise Authorizations), which can be filtered by creation date, refunded date, status, RMA.
or
- A single RMA, showing specific details on that particular Return.
Refunds (POST)
Connect your eCommerce and workflow along with logistics technologies to Returnly to initiate the refund process.
3PLs or merchants make a request to Returnly to issue a refund back to the eCommerce platform.
Refund shopper based on package information
Returnly will respond instantaneously with HTTP 202 Accepted and process the request asynchronously.
Any processing errors, whether logical (e.g. requested item(s) already refunded in Shopify) or technical (e.g. timeouts and other network issues) will be collected and displayed in Returnly dashboard for a human to review.
Refund Requests (GET)
Receive details on a collection of refund requests.
Merchants could retrieve a collection of the following:
- Refund requests.
or
- Not refunded requests.
- To learn more how to obtain your API token, read this article.
