EZI INTEGRATION
Inventory & Shipping API
Checking stock and shipping what you need, all within arms reach with our handy API!
This collection of APIs allows you to fetch information about the items we have in stock for your account, down to specific returns, then request a shipment of the same types available in your portal:
You can then fetch all unique products at a hub of your choice, and be given a count of all currently in stock.
With a single unique product in mind, you can fetch a breakdown of all instances of that product at a given hub.
Unfortunately, this part of the API is still under development. Please bear with us while we work on this.
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 Hubs
GET https://my.ezireturns.com/api/hubs
Response
You will receive back an array of our Hub Names and corresponding IDs:
[
{
"hubName": "AT",
"hubID": 34
},
{
"hubName": "AUS",
"hubID": 27
},
{
"hubName": "BEL",
"hubID": 29
}
]
Check Inventory
To check your inventory at a specific hub then make this request:
GET https://my.ezireturns.com/api/inventory/hub/:hubID
The response contains an array of each unique product at this hub. Against each you'll see the available stock and a unique ID for the product called productID. See our Product Management API for more details on how this works.
Find a Specific Item
Once you have identified a particular product then you can make a further call to get all the specific items we have received for that product
GET https://my.ezireturns.com/api/inventory/hub/:hubID/:productID
Submitting a Shipment Request
You can create a shipment request by using the information gained above and the following endpoint:
POST https://my.ezireturns.com/api/inventory/shipping-request/hub/:hubID
The request body should look like this:
{
"shipmentType": 13,
"recipient": {
"company": "",
"name": "Mr Test",
"address1": "Address line 1",
"address2": "Address line ",
"town": "Town",
"county": "County",
"postcode": "AA1 9ZZ",
"country": "GB",
"telephone": "00000 111111",
"mobile": "",
"email": "test@test.com"
},
"instructions": "Shipment instructions",
"reference": "MY_REFERENCE",
"items": [2751118]
}
The value of shipmentType should be numeric:
7 - Ship To Seller
9 - Dispose/Donate
12 - Fulfilment - B2B/FBA
13 - Fulfilment - B2C/Resell
For disposal shipments you can omit therecipient object.
The items element should be an array of the shipmentItemID values that you want to include in this shipment request
The response from this API call looks like this:
{
"status": "success",
"id": "OUTUK-1862760"
}
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.
