EZI INTEGRATION
Return Status API
Keep your records up to date by updating the Your Status and Notes for your incoming returns!
When viewing a return, you'll have the option of adding your own 'Seller Status' and 'Seller Notes', which can help you to keep track of your own processes at a glance. This API can help your system to keep these updated automatically, making sure your order management system and your Ezi Returns account stay in sync, in two simple calls:
Use a Return Reference to update the Status and Notes fields.
All API calls need to include a Bearer token:
Authorization:Bearer
Your token is available at the bottom of the Integrations tab of your label portal settings page within https://my.ezireturns.com
All Requests and Responses below contain data for example purposes only.
Fetch Your Statuses
GET https://my.ezireturns.com/api/hubs
Response
You will receive back an array of the possible statuses with their corresponding IDs:
[
{
"sellerStatusID": 1,
"sellerStatusName": "Pending"
},
{
"sellerStatusID": 2,
"sellerStatusName": "Refunded"
},
{
"sellerStatusID": 3,
"sellerStatusName": "Exchanged"
},
{
"sellerStatusID": 4,
"sellerStatusName": "Processed"
},
{
"sellerStatusID": 5,
"sellerStatusName": "Replacement Sent"
},
{
"sellerStatusID": 6,
"sellerStatusName": "Re-sold"
},
{
"sellerStatusID": 7,
"sellerStatusName": "Transferred"
},
{
"sellerStatusID": 9,
"sellerStatusName": "Dispose"
},
{
"sellerStatusID": 11,
"sellerStatusName": "Order No."
}
]
Update Statuses
Updating a Return requires the Return reference. This can either be found in the Returns portal, or be sent to you via our Webhook Solution.
POST https://my.ezireturns.com/api/seller-status/update
Request
The body of the request should look like this:
{
"shipmentSellerStatus": 3,
"shipmentSellerNotes": "my notes",
"shipmentReference": "INDE-1848278"
}
Response
The response looks like this:
{
"status": "success"
}
Other integrations
Looking for another integration? See our full list below.
(previously ChannelAdvisor)
Automated label generation through our label portal, saving you time
More accurate and comprehensive return information making it easier for you to process refunds & exchanges
Less admin time in preparing info for shipping and customs purposes
Fewer queries and less incomplete data regarding returns and shipments
Please note:
Connection
This is a one way connection initially meaning that once connected, our system sends a request based on an order number for example. We then receive the required details for the returns process relevant to that order.
Privacy & Data Protection
We are governed and abide by strict data privacy policies and laws including GDPR compliance. You can be assured we never pass on any data of any type to any other party other than what is required for shipping and customs processes.
Basic Service
If you are on our basic service, please be aware that the hubs do not open the packages on that service so the data being pulled through may contain more than 1 item. If this will be an issue for you, you will need to upgrade to use our label portal in order to pre-register returns or to upgrade to the Standard+ service where we open the packages and verify the contents. We can review this at any point in the future.
Do you need to integrate?
In short, yes. Even if you do not use our labels, are only on an FBA or Basic service, or any other reason you feel that integration would grant you little benefit, we can assure you that integrating speeds up every part of our process, no matter the service. We’ll require all sellers to integrate with us over the coming months, as most returns services already do. Shipping and courier services are moving this way for full visibility and automation of shipping and customs processes. This also improves the whole returns process in terms of accuracy and speed, providing a better experience for you, us, and your customers.
For sellers that won't or can't integrate, we can still offer some of our services, but these will be higher priced than those sellers who are integrated to account for the higher amount of work required.
Product Databases
Without an integration, we will need a product database. You can find more information about this on here.
