EZI INTEGRATIONS
Rest API Integration
Our simple REST API allows you to send us details for parcels we are going to receive at one of our hubs. This will be a fetch of information from your system into ours in a fully GDPR compliant way. If you feel that your system has a great deal of orders and only very few are going to be returned, an alternative API is available, where spreadsheets of order data can be uploaded. You can find more information here.
Create Record
| Endpoint | https://api.ezireturns.com/api/create |
|---|---|
| Method | POST |
| Authentication | You'll be supplied with a token by Ezi Returns |
Sample Request
{ "token": "YOUR_TOKEN","orderOriginal": "ORDER_NUMBER",
"orderOriginalAdditional": "ADDITIONAL_ORDER_NUMBER",
"trackingNumber": "TRACKING_NUMBER",
"invoiceNumber": "INVOICE_NUMBER",
"currency": "GBP",
"weight": 1,
"trackingOriginal": "TRACKING_ORIGINAL",
"name": "NAME",
"address1": "ADDRESS 1",
"address2": "ADDRESS 2",
"town": "TOWN",
"state": "STATE",
"postcode": "POSTCODE",
"country": "FR",
"email": "email@email.com",
"products": [
{"name": "Red Shoes",
"quantity": 1,
"hs": "12345678",
"sku": "RED1",
"price": 29.99,
"origin": "CN",
"weight": 1,
"primary_barcode": "12345678",
"secondary_barcode": "",
"image_url": "https://www.example.com/image.jpg"
}
]
}
Sample Response
{"status": "success",
"id": 224344,
"reference": "c4d50f2370fb62f4919ee1abcefe63f2"
}
Testing
We will need to test the connection to confirm we're getting the information needed for customs purposes.
Once Integrated, please provide two order numbers for preferably completed orders within your system. We'll run some tests on these orders and let you know if any fields are not mapping across. You can see below for the kinds of fields we need.
Field Summary
| Name | Description | Required |
|---|---|---|
| token | You'll be supplied a token | Required |
| orderOriginal | Required as orginal evidence of export and used to identify your customers items | Required |
| orderOriginalAdditional | Optional additional reference used to identify your customers items | Optional |
| trackingNumber | This will be known if you use our labels. | Optional |
| invoiceNumber | Required as orginal evidence of export | Optional |
| currency | Ensure you use the correct 3 digit ISO currency code. Eg GBP, EUR, USD, CAD, AUD, etc | Required |
| weight | Weight of the parcel in KG, e.g 0.5, 1.0 | Required |
| trackingOriginal | This is required as proof of orginal export from you to your customer | Required |
| name | Surname / last name is sufficent | Required |
| address1 | Address of customer | Optional |
| address2 | Address of customer | Optional |
| town | Town of the customer | Required |
| state | State/county of the customer | Optional |
| postcode | Required as orginal evidence of export | Required |
| country | Required as orginal evidence of export | Required |
| Yours or your customers email is only required if using our label portal | Optional | |
| products | An array of the item(s) being returned | Required - Array |
| products/name | Description of the item being returned Required for shipping / customs purposes. | Required |
| products/quantity | Quantity of the item being returned Required for shipping / customs purposes. | Required |
| products/hs | HSS tariff commodity code of item Required for shipping / customs purposes. | Required |
| products/sku | SKU of item Required to correctly idenitfy the item in your system. | Required |
| products/price | The price per item paid by your customer in the currency given above | Required |
| products/origin | This should be the country code for where the item was manufactured. | Required |
| products/weight | Weight per item in KG Required for shipping / customs purposes. | Required |
| products/primary_barcode | The main barcode of your item | Optional |
| products/secondary_barcode | The secondary barcode of your item If your item has more than 1 barcode then add the 2nd one here. | Optional |
| products/image_url | Useful for label generation process and processing | Optional |
