This documentation is for the v3 (stable) version of the API.
Invocation URL: /v3/collections/pickuprequest

Descripton:

Request a pickup

Parameters:

CountryCode - The country code in which the request takes place - Required
LabelNumber - The label number/s to request against, if more then one label they are to be sperated by a semi-colon
PickupStreet - The street of the pickup location - Required
PickupCity - The city of the pickup location
PickupSuburb - The suburb of the pickup location - Required
PickupPostalCode - The postal code of the pickup location - Required
PickupName - The contact name for the pickup
PickupContactName - An additional contact name for the pickup, if different from above
PickupEmail - The email to contact regarding the pickup
PickupDate - The date requested for the pickup - Required
PickupSpecialInstruction - Any special instructions for the pickup
PickupState - The state for the pickup, in New Zealand this will be NI for North Island and SI for South Island
PickupPhone - The phone number to call regarding the pickup
DeliveryStreet - The street of the delivery location
DeliveryCity - The city of the delivery location
DeliverySuburb - The suburb of the delivery location
DeliveryPostalCode - The postal code of the delivery location
DeliveryName - The contact name for the delivery
DeliveryContactName - An additional contact name for the delivery, if different from above
DeliveryEmail - The email to contact regarding the delivery
Quantity - The amount of labels/parcels - Required
RequirePrint - Optional, value shoud be true if the label(s) needs to be printed by fastway regional franchisee

Returns:

A data structure. In JSON, it looks like:

{
    result: {
        success:true
    }
}

Example:

https://api.fastway.org/v3/collections/pickuprequest?countrycode=6&LabelNumber=000000000000;000000000001&quantity=2&PickupStreet=1%20Lever%20Street&PickupSuburb=Ahuriri&PickupPostalCode=4110&PickupDate=01/03/2013&RequirePrint=true&api_key=YOUR_API_KEY

Back to Collections