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.
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.
/latest/psc/lookup/.xml
) no longer work. Format the url properly (eg /latest/psc/lookup.xml
) and it will work.Area Name | Description | Invocation URL |
---|---|---|
Customer Connect | This area contains Customer Connect API End Points | /latest/customerconnect |
Electronic Authority to leave | (e-ATL) | /latest/electronicatl |
etacalculator | /latest/etacalculator | |
Price Service Calculator | Determine the cost to send goods between two locations. | /latest/psc |
Track and Trace | This area contains track/trace related API calls. | /latest/tracktrace |
Area Name | Description | Invocation URL |
---|---|---|
Collections | Methods for informing Fastway of needed collections | /latest/collections |
Dynamic Labels | Methods dealing with dynamic label allocation to third parties. | /latest/dynamiclabels |
Electronic labels IFS / Compdata | This area contains methods for sending and receiving data for third party label printing systems. | /latest/electroniclabels |
enquiry | /latest/enquiry | |
External Labels | Allow externally labeled parcels to move through the network as normal. | /latest/externallabels |
FastLabel | All the calls centering around FastLabel live in here. | /latest/fastlabel |
Fms National Master | This area contains methods relating to FMS from a National perspective. | /latest/fmsnm |
Franchise Information | Contains methods for extracting information about Fastway franchises. | /latest/franchise |
FSO | /latest/fso | |
Labels | This area contains methods relating to Label information | /latest/labels |
MyLocate | Methods dealing with the MyLocate data. | /latest/mylocate |
ParcelConnect | This area contains methods for interacting with Parcel connect | /latest/parcelconnect |
parcelconnectcollectservice | /latest/parcelconnectcollectservice | |
parcelconnectreturnservice | Returns Service | /latest/parcelconnectreturnservice |
parcelconnectsendservice | /latest/parcelconnectsendservice | |
PayZone | This section contains all the PayZone related API calls. | /latest/payzone |
PostPlus | This area contains methods for interacting with PostPlus | /latest/postplus |
receiverpays | /latest/receiverpays | |
Remote Agent | The API calls that the Fastway Remote Agent uses live here | /latest/agent |
RSS Feeds | Contains RSS feeds of various Fastway information as it occurs | /latest/rss |
sprinklrservice | Returns Service | /latest/sprinklrservice |
systemstatus | System Status | /latest/systemstatus |
Temando | Methods for requesting a pickup | /latest/temando |
Third Party Couriers | This area contains Courier specific related API calls and render methods. | /latest/thirdpartycouriers |
Trans tasman | All the calls centering around trans tasman live in here. | /latest/transtasman |
underticketing | /latest/underticketing | |
Yodel | This area contains methods for interacting with Yodel | /latest/yodel |
zendeskservice | Returns Service | /latest/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.
Some of our API calls require Country Codes. Here are the valid ones: