Introduction
Welcome to the Returnless Developer API documentation. You can use our API in case you want to develop your own custom integration with our platform. We also provide pre-build integrations in case you're using any of our supported platforms. Please have a look at our Integrations page for the available integrations.
Basics
HTTPS and JSON Only
The Returnless API is only accessible through HTTPS and requests and responses are always JSON formatted.
Rate limiting
There is a rate limit per user per IP address. If you get rate limited, we return an empty response with HTTP status code 429.
Authentication
Generate API credentials
Login to your return portal and navigate to the API keys section. There you can generate a new API user and API password.
Add the API credentials to your request
Use Basic Auth to set the API user and API password and connect with the API.
Changelog
23 January 2023
Added a width, length and height to the Order Info response.
2 November 2022
Introducing a new "Shipments" endpoint 📦.
1 November 2022
Added "return_notes" to the Requests endpoint.
Added "return_notes" to the Returns endpoint.
13 Oktober 2022
Added "files" to the Returns endpoint.
9 September 2022
Added "return_questions" to the Returns webhook.
8 September 2022
Added "shipping_label_link" to the Returns webhook.
1 September 2022
Added "shipping_label_link" to the Returns endpoint.
15 July 2022
Added "return_questions" to the Returns endpoint.
12 July 2022
Added option to PUT Requests endpoint: Toggle free_shipping 0 or 1 to decide if a request can be returned for free or not.
4 May 2022
Added new feature "force_address" to the Get Order Info endpoint.
3 May 2022
Added "return_type" parameter to the Returns endpoint.
13 April 2022
Added a "sort_order" parameter to the Requests and Returns endpoint to sort by oldest or newest items. Happy sorting! 🔝
7 April 2022
Added an "updated_after" filter to the Requests endpoint.
5 April 2022
Added the "shipping_description" to the Returns response.
23 February 2022
Added an "updated_after" filter to the Returns endpoint.
4 October 2021
Added a per_page parameter to the Requests and Returns endpoint.
26 Augustus 2021
Added a filter possibility to the Requests endpoint.
17 Augustus 2021
Added a filter possibility to the Returns endpoint.
1 Augustus 2021
Added the new Requests endpoint to get and update return requests.
30 March 2021
Added the new Returns endpoint to get and update returns.
16 February 2021
We've added a Phone field in the customer container. When you provide us with a Phone number of your customer, we will add it to a Gate-Keeper request. Also the phone number is used when creating a Budbee shipment as they require it for sending notifications for the pick-up.
28 December 2020
We've added a Country field in the billing_address container. When you provide us with a Country code in the response, we will prefill it for your customer.
11 December 2020
Added parameter descriptions for Order Info API.
17 November 2020
Initial release of our API 🎉