<!DOCTYPE html>
<html>
    <head>
        <title>Fastway API</title>
        <link rel="stylesheet" type="text/css" href="/public/stylesheets/bootstrap/css/bootstrap.min.css"/>
        
        <script type="text/javascript" src="/public/javascript/jquery.min.js"></script>
        <script type="text/javascript" src="/public/javascript/bootstrap.min.js"></script>

        
    <style type="text/css">
        #container
        {
            padding-top: 50px;
        }
    </style>

    </head>
    <body>
        



<div id="container" class="container">
    <div class="navbar navbar-fixed-top">
        <div class="navbar-inner">
            <div class="container">
                <a class="brand" href="/v2/docs.html">Fastway API</a>
                <ul class="nav">
                    <li class="dropdown" id="api-versions">
                        <a class="dropdown-toggle" data-toggle="dropdown" href="#api-versions">API Versions<b class="caret"></b></a>
                        <ul class="dropdown-menu">
                                <li><a href="/latest/docs/index.html">latest</a></li>
                                <li><a href="/v1/docs/index.html">v1</a></li>
                                <li><a href="/v1.Models/docs/index.html">v1.Models</a></li>
                                <li><a href="/v2/docs/index.html">v2</a></li>
                                <li><a href="/v3/docs/index.html">v3</a></li>
                                <li><a href="/v4/docs/index.html">v4</a></li>
                                <li><a href="/v5/docs/index.html">v5</a></li>
                                <li><a href="/v6/docs/index.html">v6</a></li>
                                <li><a href="/v7/docs/index.html">v7</a></li>
                        </ul>
                    </li>
                    <li><a href="/v2/docs/page/GetAPIKey.html">Get API Key</a></li>
                    <li><a href="/v2/docs/page/MakeAPICall.html">Making Calls</a></li>
                    <li><a href="/v2/docs/page/FAQ.html">FAQ</a></li>
                    <li><a href="/v2/docs/page/Contact.html">Contact</a></li>
                    <li><a href="/v2/docs/MyAccount">My Account</a></li>
                </ul>
           
            </div>
        </div>
    </div>
    <div style="">
        <div class="alert alert-warning">
            This documentation is for the v2 (stable) version of the API.
        </div>        
    

<div class="row">
    <div class="span12">
        <h2>Overview</h2>
        <p>
            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.
        </p>
        <p style="color: red;">
            The API is intended for use by <strong>programmers</strong> only. If you are not a programmer, please refer to the
            <a href="/v2/docs/page/FAQ.html">FAQ</a> page.
        </p>
        <p>
            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.
        </p>
    </div>
</div>

<div class="row" style="margin-top:20px;">
    <div class="span12">
        <div class="well">
            <h2>API support</h2>
            <p>
                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.
            </p>
            <p>
                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.
            </p>
        </div>
    </div>
</div>
<div class="row">
    <div class="span6">
        <h2>What's New</h2>
        <div class="well">
            <ul>
                    <li>Ported to ASP.NET MVC</li>
                    <li>Added versioning support</li>
                    <li>Completely re-did documentation</li>
            </ul>
        </div>
    </div>
    <div class="span6">
        <h2>Known Issues</h2>
        <div class="well">
            <ul>
                    <li>The 'Search API Docs' function above does not work.</li>
                    <li>Badly formed urls that used to work (eg <code>/latest/psc/lookup/.xml</code>) no longer work. Format the url properly (eg <code>/latest/psc/lookup.xml</code>) and it will work.</li>
            </ul>
        </div>
    </div>
</div>
<h2>Available areas:</h2>
<table class="table table-bordered table-striped">
    <thead>
        <tr>
            <th width="20%">Area Name</th>
            <th>Description</th>
            <th width="30%">Invocation URL</th>
        </tr>
    </thead>
    <tbody>
            <tr>
                <td><a href="/v2/docs/detail?ControllerName=customerconnect&api_key=">Customer Connect</a></td>
                <td>This area contains Customer Connect API End Points</td>
                <td>/v2/customerconnect</td>
            </tr>
            <tr>
                <td><a href="/v2/docs/detail?ControllerName=psc&api_key=">Price Service Calculator</a></td>
                <td>Determine the cost to send goods between two locations.</td>
                <td>/v2/psc</td>
            </tr>
            <tr>
                <td><a href="/v2/docs/detail?ControllerName=tracktrace&api_key=">Track and Trace</a></td>
                <td>This area contains track/trace related API calls.</td>
                <td>/v2/tracktrace</td>
            </tr>
    </tbody>
</table>

<h2>Restricted areas:</h2>
<table class="table table-bordered table-striped">
    <thead>
        <tr>
            <th width="20%">Area Name</th>
            <th>Description</th>
            <th width="30%">Invocation URL</th>
        </tr>
    </thead>
    <tbody>
            <tr>
                <td><strong>Collections</strong></td>
                <td>Methods for informing Fastway of needed collections</td>
                <td>/v2/collections</td>
            </tr>
            <tr>
                <td><strong>Dynamic Labels</strong></td>
                <td>Methods dealing with dynamic label allocation to third parties.</td>
                <td>/v2/dynamiclabels</td>
            </tr>
            <tr>
                <td><strong>Electronic labels IFS / Compdata</strong></td>
                <td>This area contains methods for sending and receiving data for third party label printing systems.</td>
                <td>/v2/electroniclabels</td>
            </tr>
            <tr>
                <td><strong>External Labels</strong></td>
                <td>Allow externally labeled parcels to move through the network as normal.</td>
                <td>/v2/externallabels</td>
            </tr>
            <tr>
                <td><strong>FastLabel</strong></td>
                <td>All the calls centering around FastLabel live in here.</td>
                <td>/v2/fastlabel</td>
            </tr>
            <tr>
                <td><strong>Fms National Master</strong></td>
                <td>This area contains methods relating to FMS from a National perspective.</td>
                <td>/v2/fmsnm</td>
            </tr>
            <tr>
                <td><strong>Franchise Information</strong></td>
                <td>Contains methods for extracting information about Fastway franchises.</td>
                <td>/v2/franchise</td>
            </tr>
            <tr>
                <td><strong>FSO</strong></td>
                <td></td>
                <td>/v2/fso</td>
            </tr>
            <tr>
                <td><strong>MyLocate</strong></td>
                <td>Methods dealing with the MyLocate data.</td>
                <td>/v2/mylocate</td>
            </tr>
            <tr>
                <td><strong>ParcelConnect</strong></td>
                <td>This area contains methods for interacting with Parcel connect</td>
                <td>/v2/parcelconnect</td>
            </tr>
            <tr>
                <td><strong>parcelconnectcollectservice</strong></td>
                <td></td>
                <td>/v2/parcelconnectcollectservice</td>
            </tr>
            <tr>
                <td><strong>parcelconnectreturnservice</strong></td>
                <td>Returns Service</td>
                <td>/v2/parcelconnectreturnservice</td>
            </tr>
            <tr>
                <td><strong>parcelconnectsendservice</strong></td>
                <td></td>
                <td>/v2/parcelconnectsendservice</td>
            </tr>
            <tr>
                <td><strong>PayZone</strong></td>
                <td>This section contains all the PayZone related API calls.</td>
                <td>/v2/payzone</td>
            </tr>
            <tr>
                <td><strong>PostPlus</strong></td>
                <td>This area contains methods for interacting with PostPlus</td>
                <td>/v2/postplus</td>
            </tr>
            <tr>
                <td><strong>Remote Agent</strong></td>
                <td>The API calls that the Fastway Remote Agent uses live here</td>
                <td>/v2/agent</td>
            </tr>
            <tr>
                <td><strong>RSS Feeds</strong></td>
                <td>Contains RSS feeds of various Fastway information as it occurs</td>
                <td>/v2/rss</td>
            </tr>
            <tr>
                <td><strong>sprinklrservice</strong></td>
                <td>Returns Service</td>
                <td>/v2/sprinklrservice</td>
            </tr>
            <tr>
                <td><strong>systemstatus</strong></td>
                <td>System Status</td>
                <td>/v2/systemstatus</td>
            </tr>
            <tr>
                <td><strong>Temando</strong></td>
                <td>Methods for requesting a pickup</td>
                <td>/v2/temando</td>
            </tr>
            <tr>
                <td><strong>Third Party Couriers</strong></td>
                <td>This area contains Courier specific related API calls and render methods.</td>
                <td>/v2/thirdpartycouriers</td>
            </tr>
            <tr>
                <td><strong>Trans tasman</strong></td>
                <td>All the calls centering around trans tasman live in here.</td>
                <td>/v2/transtasman</td>
            </tr>
            <tr>
                <td><strong>underticketing</strong></td>
                <td></td>
                <td>/v2/underticketing</td>
            </tr>
            <tr>
                <td><strong>Yodel</strong></td>
                <td>This area contains methods for interacting with Yodel</td>
                <td>/v2/yodel</td>
            </tr>
            <tr>
                <td><strong>zendeskservice</strong></td>
                <td>Returns Service</td>
                <td>/v2/zendeskservice</td>
            </tr>
    </tbody>
</table>

<p>
    Restricted areas are not available to the general public, however access can be requested. See the <a href="/v2/docs/page/Contact.html">contact</a> page for more info.
If you have been granted access to restricted areas, the documentation can be viewed by appending the <strong>api_key</strong> parameter to this page with your API key.
</p>

<h2 id="cc">Country Codes</h2>
<p>
    Some of our API calls require Country Codes. Here are the valid ones:
    <ul>
        <li><strong>1</strong> - Australia</li>
        <li><strong>6</strong> - New Zealand</li>
        <li><strong>11</strong> - Ireland & N.Ireland</li>
        <li><strong>24</strong> - South Africa</li>
    </ul>
</p>



        </div>
</div>

    </body>
</html>
