This documentation is for the v1 (stable) version of the API.

Overview

The Fastway API is a RESTful API that is intended to be invoked by third parties in order to take advantage of and integrate with our internal systems.

The API is intended for use by programmers only. If you are not a programmer, please refer to the FAQ page.

The API is divided into areas. Each area has methods that can be called that relate to that area. Each method call is represented by a URI.

API support

Fastway provides support for programmers who access the Fastway API directly from this site. If you’re a developer and you’re experiencing issues with the API functionality and require support, please contact Fastway and ensure you have an example of the API call (URL) you’re trying to make.

Unfortunately, Fastway doesn’t provide support for customers experiencing issues with pre-built/3rd party plug-ins for eCommerce solutions. If you’re experiencing issues with such a plug-in you’ll need to contact the developer of that software.

What's New

  • Ported to ASP.NET MVC
  • Added versioning support
  • Completely re-did documentation

Known Issues

  • The 'Search API Docs' function above does not work.
  • Badly formed urls that used to work (eg /latest/psc/lookup/.xml) no longer work. Format the url properly (eg /latest/psc/lookup.xml) and it will work.

Available areas:

Area Name Description Invocation URL
Customer Connect This area contains Customer Connect API End Points /v1/customerconnect
Price Service Calculator Determine the cost to send goods between two locations. /v1/psc
Track and Trace This area contains track/trace related API calls. /v1/tracktrace

Restricted areas:

Area Name Description Invocation URL
Collections Methods for informing Fastway of needed collections /v1/collections
Dynamic Labels Methods dealing with dynamic label allocation to third parties. /v1/dynamiclabels
Electronic labels IFS / Compdata This area contains methods for sending and receiving data for third party label printing systems. /v1/electroniclabels
External Labels Allow externally labeled parcels to move through the network as normal. /v1/externallabels
FastLabel All the calls centering around FastLabel live in here. /v1/fastlabel
Fms National Master This area contains methods relating to FMS from a National perspective. /v1/fmsnm
Franchise Information Contains methods for extracting information about Fastway franchises. /v1/franchise
FSO /v1/fso
MyLocate Methods dealing with the MyLocate data. /v1/mylocate
parcelconnectcollectservice /v1/parcelconnectcollectservice
parcelconnectreturnservice Returns Service /v1/parcelconnectreturnservice
parcelconnectsendservice /v1/parcelconnectsendservice
PostPlus This area contains methods for interacting with PostPlus /v1/postplus
sprinklrservice Returns Service /v1/sprinklrservice
systemstatus System Status /v1/systemstatus
Temando Methods for requesting a pickup /v1/temando
Third Party Couriers This area contains Courier specific related API calls and render methods. /v1/thirdpartycouriers
Trans tasman All the calls centering around trans tasman live in here. /v1/transtasman
underticketing /v1/underticketing
Yodel This area contains methods for interacting with Yodel /v1/yodel
zendeskservice Returns Service /v1/zendeskservice

Restricted areas are not available to the general public, however access can be requested. See the contact page for more info. If you have been granted access to restricted areas, the documentation can be viewed by appending the api_key parameter to this page with your API key.

Country Codes

Some of our API calls require Country Codes. Here are the valid ones: