EZI INTEGRATION
Webhooks

Webhooks allow us to send you information whenever one of our hub partners process one of your returns. This information goes to a URL that you can setup, and includes the details that follow.

Please be sure to send any webhook URL you setup to techsupport@ezireturns.com and we will add it to your account as soon as we can.

You can find an example of the kind of data that will be sent in JSON format to any URL that you setup. This includes some sample data, and shows that even if a field is empty, it is still included, and also that a return with multiple items will include each item scanned in:


{
  "shipmentReference": "INIT-1610201",
  "shipmentCreated": "2026-05-22 11:23:31",
  "hubName": "IT",
  "serviceName": "Standard+",
  "customerName": "DEMO Standard+ Ltd",
  "tradingName": "DEMO Standard+",
  "customerAccountCode": "XXXXXDFBA",
  "shipmentTracking": "No tracking reference",
  "shipmentOrderNumber": "ORD1234NO5678",
  "shipmentInvoiceNumber": "",
  "shipmentReturnName": "Smith",
  "shipmentOversize": 0,
  "shipmentIncorrectlyAddressed": 0,
  "shipmentProhibitedItems": 0,
  "shipmentWeight": "0.00",
  "items": [
    {
      "shipmentItemReference": "INIT-1610201Q1",
      "shipmentItemGrade": "",
      "shipmentItemGradeReason": "",
      "shipmentItemReason": null,
      "shipmentItemAction": null,
      "shipmentScannedBarcode": "5602991016746",
      "productBarcode": "5602991016746",
      "productDescription": "CS4001 - Navy Blue - XS",
      "productSKU": "",
      "productAttribute1": "",
      "productAttribute2": "",
      "productAttribute3": "",
      "shipmentPhotos": []
    },
    {
      "shipmentItemReference": "INIT-1610201Q2",
      "shipmentItemGrade": "",
      "shipmentItemGradeReason": "",
      "shipmentItemReason": null,
      "shipmentItemAction": null,
      "shipmentScannedBarcode": "5056545542869",
      "productBarcode": "5056545542869",
      "productDescription": "Dobell Green Windowpane Check Wool Blend Jacket",
      "productSKU": "JN2CMCBDP750R",
      "productAttribute1": "",
      "productAttribute2": "",
      "productAttribute3": "",
      "shipmentPhotos": []
    }
  ]
}


Technical FAQs

Yes, we include a header called X-Signature and this is a HMAC signature (specifically HMAC-SHA256 with the raw body of the request). The secret is will be your Ezi Account Code, which can be given on request.

Yes, we try 5 times over the course of a few hours if the delivery hasn’t returned a status code starting with a 2

We can set an activation date and send every return after that date. By default, this is the date your URL is added to your account. If you'd like older returns sent, please let us know.

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.