EZI INTEGRATION
Label Portal API
All the benefits of our Label Portal controlled directly from your own system!
This API allows you to trigger the main actions of the label portal. A brief overview of the three calls included in this API are as follows:
You can fetch the available services for a specified country, postcode, and weight.
You can create a new label portal return by supplying valid information.
You can fetch the PDF label for an order (created manually or through the API).
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.
Checking available services
POST https://my.ezireturns.com/api/labels/services
Request
You need to specify the weight of the parcel (in KG), the country that the parcel is being returned from and then the postcode of the sender.
{
"weight": 2,
"country": "GB",
"postcode": "W14 9HU"
}
Response
You will receive back an array of all suitable services. The serviceID value is required if you would like to proceed with creating a label
[
{
"serviceSKU": "LABRBDPDQUK2",
"serviceNameCustomer": "DPD Parcel Shop UK2 - QR Code Printerless",
"serviceCarrierName": "DPD",
"serviceExternalCode": "439",
"maxDimensions": "Max L+ 2H + 2W. Max length 100cm",
"maxWeight": "15kg",
"serviceProvider": 52,
"serviceDetails": "",
"serviceID": 138,
"portalSellCurrency": "GBP",
"sellPrice": "0.00",
"minWeightNumeric": "0.00",
"maxWeightNumeric": "15.00",
"maximumCompensation": "£50/ $70/ €55",
"logoURL": "https://my.ezireturns.com/assets/label-portal-logos/-DPD.png",
"formattedSellPrice": "FREE",
"isFree": true
},
{
"serviceSKU": "LABRBDPDQUK",
"serviceNameCustomer": "DPD Printerless",
"serviceCarrierName": "DPD",
"serviceExternalCode": "439",
"maxDimensions": "Max L+ 2H + 2W. Max length 100cm",
"maxWeight": "15Kg",
"serviceProvider": 52,
"serviceDetails": "",
"serviceID": 137,
"portalSellCurrency": "GBP",
"sellPrice": "0.00",
"minWeightNumeric": "0.00",
"maxWeightNumeric": "15.00",
"maximumCompensation": "£50/ $70/ €55",
"logoURL": "https://my.ezireturns.com/assets/label-portal-logos/-DPD.png",
"formattedSellPrice": "FREE",
"isFree": true
}
]
Creating a label
POST https://my.ezireturns.com/api/labels/create
Include the serviceID of the service you wish to use. The items array within step3 contains many optional fields but the more you can specify the better.
Request
{
"step1": {
"orderNumber": "test",
"email": "test@test.com",
"postcode": "TEST"
},
"step2": {
"name": "Mr Test",
"address1": "123 Test Street",
"address2": "",
"town": "London",
"county": "",
"postcode": "W14 9HU",
"country": "GB"
},
"step4": {
"serviceID": 74
},
"step3": {
"items": [
{
"quantity": 1,
"name": "Nike shirt Black M",
"hs": 61090000,
"sku": 5753494405216,
"image": "https://labels.ezireturns.com/assets/images/demo-nike.jpg",
"price": 100,
"origin": "CN",
"weight": 1,
"barcode": "123456",
"barcode2": "",
"reason": "Arrived damaged",
"action": "Exchange"
}
],
"message": "message to seller",
"weight": 1
}
}
Response
{
"status": "success",
"id": "d59d0139-3b97-4723-8490-17177f738980"
}
Downloading a label
POST https://my.ezireturns.com/api/labels/download
Request
Include the id that you received when creating the return.
{
"id": "d59d0139-3b97-4723-8490-17177f738980"
}
Response
{
"status": "ok",
"tracking": "9A000111222",
"pdf": "JVBERi0x....2CiUlRU9GCg=="
}
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.
