Integration Field Summary

Our integration works by fetching data from records within your order management system. For this to function properly, some fields are mandatory and required to both be fetchable by us, and to have their values populated within your system.

These critical fields can sometimes change depending on certain variables. Where you can ship From and To, the Service Levels of your account with us, the Order Management software you use, all can play a part. We ask that you read the list below carefully to determine what you need to send, and remember that sending as much of the data requested as possible is preferred as it will speed up our processes, even if it’s listed as optional. 

 Name Description Required
 token You'll be supplied a token Required
 orderOriginal Required as original 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 original 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 original export from you to your customer Required
 name Surname / last name is sufficient 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 original evidence of export Required
 country Required as original 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        -
 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 identify 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. Lbs will be converted automatically for all but our Rest API integration
 Required
 products/primary_barcode The main barcode of your item
If your item has more than 1 barcode then add the 2nd one here.
 Optional
 products/secondary_barcode The secondary barcode of your item Optional
 products/image_url Useful for label generation process and processing Optional
Return to Integration Instructions