Backwards Compatibility

While version 1 of the API will remain alive for the time being, we understand the amount of time and effort it can take to completely upgrade and update an integration. We have made the consious effort to keep the changes between version 1 and 2 to a minimum whilst offering extended function and data.

While the API allows for an easy transition, we do recommend updating the integration at the earlist possible oppertunity. There is additional data being sent back with the lookup request, as well as the error codes being sent back having been updated and changed in many places.

What do you need to do to upgrade?

If you are already utilising version 1 of the API, moving to version 2 can be as simple as changing the endpoint you are making the request to. Simply change the url from /api to /api/v2/xml.

If you are looking out for specific error codes, the codes may need to be updated to reflect the new codes. You can find the new codes here and the old codes here.

A warning for international shipments: Our API has been updated to properly handle the increased requirements for all international shipments and now will always require customs data to be sent along with the booking request.

The new API can now accept an XML as body content rather than needing to post it via a the post field xmldata. You can also now use JSON requests instead of XML.