Alert!

This is the latest version of the API! It is subject to change and may contain bugs! Use only for testing new features or at your own risk.
Invocation URL: /latest/psc/pickuprf

Descripton:

Perform a query that returns the Pickup RF for a particular postcode.

Parameters:

PostCode - The Postcode you want to lookup the RF for.
CountryCode - The country in which the specified Postcode resides.
Suburb - Optional, helps narrow down conflicting postcodes in countries that dont have a very well structured postcode system (eg, AU and NZ)

Returns:

A data structure. In JSON, it looks like:

{
    result: {
        franchise_code: 'SYD'
        franchise_name: 'Sydney'
        franchise_email: 'sydney@fastway.org'
        franchise_country: 'Australia'
    }
}

Example:

Lookup the RF for postcode '2155' in country '1':
http://wheedle.fastway.org/latest/psc/pickuprf/2155/1?api_key=YOUR_API_KEY

Back to Price Service Calculator