API Documentation - Spreadsheet Upload Alternative

Our simple REST API allows you to send us details for parcels we may receive at one of our hubs. Unlike the regular API, through which the data of all your orders is collected, this allow for a single spreadsheet upload and is useful for sellers with a large number of orders, very few of which will be returned through us.

 

The Process

To get this setup, you'll first need to create a CSV file that has the required fields as outlined below in the Field Summary as columns, along with any other data you can add for your orders, again laid out in the Feild Summary. This will be your upload template and the columns and headers you add to it should not be changed.

Email this CSV Spreadsheet file to us at info@ezireturns.com and our development team will write a loader that matches your columns to the fields within our system. (This is why the columns should remain consistent later as a change in columns will mean the loader will stop working and need to be remade by us).

Once this has been done, we’ll let you know some FTP details where you can send your CSV files to us and the data within will be transferred to our system. This will allow it to both appear in the label portal and during our Hubs processes.

 

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"
  }

 

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
email 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