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

Descripton:

This method is used for clients who maintain an offsite pool of labels. This method must be called for invoicing and label distribution purposes. A label can only be sent once, an error will be thrown if the label has already been allocated.

Parameters:

Is an array of 'Items'. Simply increment the index number to send multiple items as shown in the example.
Items[0].LabelNumber - The Fastway label number to be updated
Items[0].PickupTown - The Pickup Town (eg, 'Napier') *Required
Items[0].PickupRFCode - The pickup code for the Fastway Franchise (eg, 'AUK', 'SYD') see Franchisees by Postcode Use this in place of Pickup Postcode and Pickup Town *Required
Items[0].DeliveryAddr1 - The Delivery address line 1 (eg, '123 test street') *Required
Items[0].DeliveryAddr2 - The Delivery address line 2 (eg, 'Unit 52')
Items[0].DeliveryTown - The Delivery Town (eg, 'Napier') *Required
Items[0].DeliveryPostcode - The postal code for delivery suburb *Required
Items[0].UniqueID - The unique identifier you would like to use to track this transaction

Returns:

A data structure. In JSON, it looks like:

{
    result: [
        {
        allocatedToRf: 'AUK',
        costExGST: '9.25',
        colour: 'RED',
        action: 'inserted'
        },
        {
        allocatedToRf: 'AUK',
        costExGST: '9.25',
        colour: 'RED',
        action: 'inserted'
        }
        ],
    generated_in: '161ms'
}

Example:

NZ
https://api.fastway.org/v3/dynamiclabels/manualallocationv3?api_key=YOUR_API_KEY&Items[0].LabelNumber=FQ0987654321&Items[0].PickupPostcode=1010&Items[0].PickupTown=Auckland&Items[0].PickupRFCode=AUK&Items[0].UniqueID=73112753&Items[0].DeliveryPostcode=4112&Items[0].DeliveryTown=Napier&Items[0].DeliveryAddr1=123%20test%20street&Items[1].LabelNumber=FQ0987654322&Items[1].PickupPostcode=1010&Items[1].PickupTown=Auckland&Items[1].PickupRFCode=AUK&Items[1].UniqueID=73112757&Items[1].DeliveryPostcode=4112&Items[1].DeliveryTown=Napier&Items[1].DeliveryAddr1=123%20test%20street
AU
https://api.fastway.org/v3/dynamiclabels/manualallocationv3?api_key=YOUR_API_KEY&Items[0].LabelNumber=FQ0987654321&Items[0].PickupPostcode=2000&Items[0].PickupTown=Sydney&Items[0].PickupRFCode=SYD&Items[0].UniqueID=73112754&Items[0].DeliveryPostcode=2000&Items[0].DeliveryTown=Sydney&Items[0].DeliveryAddr1=123 test street

Back to Dynamic Labels